Webservice zur Übertragung von Daten über kommunale Online-Dienste in das BayernPortal (Import-Webservice für IT-Dienstleister) (Version 1)

Allgemeine Informationen

Als Teil der Digitalisierungsstrategie des Freistaats Bayern ("Montgelas 3.0") wurde der Verwaltungsservice Bayern zum BayernPortal weiterentwickelt. Das BayernPortal bietet Bürgern und Unternehmen einen zentralen Zugang zu eGovernment-Angeboten im Freistaat Bayern. Viele Online-Dienste sind nur über die Internetseite der Kommune zugänglich. Dabei nehmen viele bayerische Kommunen die Online-Dienste ihrer IT-Dienstleister in Anspruch.

Um diese regional verfügbaren, kommunalen Online-Dienste über Verlinkungen auch im BayernPortal zugänglich zu machen, stellt der Freistaat Bayern eine kostenlose Upload-Schnittstelle zur Verfügung. Die Nutzung dieser Schnittstelle ist freiwillig. Kommunale IT-Dienstleister müssen eine entsprechende "Gegen-Schnittstelle" bereitstellen, die die Daten für den Import in das Redaktionssystem zur Verfügung stellt.

Wie bereits bisher ist es auch weiterhin möglich, Online-Verfahren manuell über das Redaktionssystem (https://www.bayvis-redaktionssystem.bayern.de) zu erfassen und bei den entsprechenden Leistungen zu verlinken. Nun wird für kommunale IT-Dienstleister eine weitere einfache Möglichkeit angeboten, die Online-Verfahren von Behörden im BayernPortal automatisch einzustellen und zu verlinken.

Der Webservice kann nur von IT-Dienstleistern genutzt werden, die für mehrere Städte, Gemeinden, Verwaltungsgemeinschaften oder Landkreise (hier "Mandanten" genannt) Online-Dienste bereitstellen. Sie können im Auftrag der Kommunen über diese Upload-Schnittstelle Daten über die Online-Dienste (z. B. Bezeichnung, Beschreibung und URL) aller ihrer Mandanten in das Redaktionssystem hochladen. Die Daten werden nach dem Hochladen automatisch validiert und anschließend mit Leistungen und ggf. Übersichtsseiten verknüpft. Die importierten Online-Dienste werden im BayernPortal als regionale Ergänzungen nach Auswahl der Leistung und des entsprechenden Ortes angezeigt. Im BayernPortal werden sie auch über die Behördenseite und ggf. über die Online-Verfahren-Übersichten zugänglich sein. Es ist immer erkennbar, welche Kommune den Online-Dienst anbietet.

Technische und organisatorische Angaben (Überblick)

Erläuterungen im Detail

Request

Senden Sie einen HTTP POST an die oben angegebene URL. Beachten Sie die HTTP-Header "Content-Type" und "Authorization". Die hochzuladende XML-Datei steht im Body der POST-Nachricht.

Beispiel:

            POST https://www.baybw-services.bayern.de/rest/onlinedienste/upload HTTP/1.1
            Content-Type: application/xml
            Authorization: Basic MDxxxxxxxxxxxxxxxxxxxxxxxxxx
            
            <?xml version="1.0" encoding="UTF-8"?>
            <import  xmlns="http://ldbv.bayern.de/baybw/upload/onlinedienste/v1" 
                xmlns:xoev-dt="http://xoev.de/schemata/basisdatentypen/1_0" 
                xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" 
                xsi:schemaLocation="http://ldbv.bayern.de/baybw/upload/onlinedienste/v1 import-onlinedienste.xsd">
                <nachrichtenkopf>
                    <absender>Bürgerservice-Portal der AKDB</absender>
                    <stand>2015-07-24T13:39:34</stand>
                </nachrichtenkopf>
                <onlinedienste>
                    <od>
                        <odKennung>bsp_geburtsurkunde</odKennung>
                        <odTitel>Geburtsurkunde</odTitel>
                        <odBeschreibung>Sie können eine Geburtsurkunde online beantragen.</odBeschreibung>
                        <odUrl>https://www.buergerserviceportal.de/bayern/arnstorf/bsp_geburtsurkunde</odUrl>
                        <odKategorie>ONLINEVERFAHREN</odKategorie>
                        <mandantKennung>/bayern/arnstorf</mandantKennung>
                        <mandantDienststellennummer>2771110</mandantDienststellennummer>
                        <mandantGemeindeschluessel>09277111</mandantGemeindeschluessel>
                    </od>
                    <od>
                        <odKennung>bsp_eheurkunde</odKennung>
                        <odTitel>Eheurkunde</odTitel>
                        <odBeschreibung>Sie können eine Eheurkunde online beantragen.</odBeschreibung>
                        <odUrl>https://www.buergerserviceportal.de/bayern/arnstorf/bsp_eheurkunde</odUrl>
                        <odKategorie>ONLINEVERFAHREN</odKategorie>
                        <mandantKennung>/bayern/arnstorf</mandantKennung>
                        <mandantDienststellennummer>2771110</mandantDienststellennummer>
                        <mandantGemeindeschluessel>09277111</mandantGemeindeschluessel>
                    </od>
                    <od>
                        <odKennung>bsp_geburtsurkunde</odKennung>
                        <odTitel>Geburtsurkunde</odTitel>
                        <odBeschreibung>Sie können eine Geburtsurkunde online beantragen.</odBeschreibung>
                        <odUrl>https://www.buergerserviceportal.de/bayern/trostberg/bsp_geburtsurkunde</odUrl>
                        <odKategorie>ONLINEVERFAHREN</odKategorie>
                        <mandantKennung>/bayern/trostberg</mandantKennung>
                        <mandantDienststellennummer>1891570</mandantDienststellennummer>
                        <mandantGemeindeschluessel>09189157</mandantGemeindeschluessel>
                    </od>
                    <od>
                        <odKennung>bsp_eheurkunde</odKennung>
                        <odTitel>Eheurkunde</odTitel>
                        <odBeschreibung>Sie können eine Eheurkunde online beantragen.</odBeschreibung>
                        <odUrl>https://www.buergerserviceportal.de/bayern/trostberg/bsp_eheurkunde</odUrl>
                        <odKategorie>ONLINEVERFAHREN</odKategorie>
                        <mandantKennung>/bayern/trostberg</mandantKennung>
                        <mandantDienststellennummer>1891570</mandantDienststellennummer>
                        <mandantGemeindeschluessel>09189157</mandantGemeindeschluessel>
                    </od>
                </onlinedienste>
            </import>
            

Response (erfolgreich)

Wenn die XML-Datei akzeptiert wurde, erhalten Sie einen Response-Code 201. Der Body der Antwort enthält u.a. Informationen zum Absender und Stand.

Beispiel:

            HTTP/1.1 201 Created
            Server: xxx
            Content-Type: application/xhtml+xml
            Content-Length: 478
            Date: Wed, 26 Aug 2015 12:21:48 GMT
            
            <?xml version="1.0" encoding="UTF-8" standalone="yes"?>
            <importResponse xmlns="http://ldbv.bayern.de/baybw/upload/onlinedienste/v1">
                <processedImport>
                    <absender>Bürgerservice-Portal der AKDB</absender>
                    <stand>2015-07-24T13:39:34+02:00</stand>
                </processedImport>
                <resultInfo>
                    <importId>321</importId>
                    <message>Importdaten erfolgreich verarbeitet.</message>
                    <rowCount>4</rowCount>
                </resultInfo>
            </importResponse>
            

Response (Validierungsfehler)

Wenn die XML-Datei nicht akzeptiert wurde, erhalten Sie einen Response-Code 400. Dies kann z.B. geschehen, wenn der Inhalt nicht valide ist:

Beispiel:

            HTTP/1.1 400 Bad Request
            Server: xxx
            Content-Type: application/xhtml+xml
            Content-Length: 741
            Date: Wed, 26 Aug 2015 12:22:48 GMT
            
            <?xml version="1.0" encoding="UTF-8" standalone="yes"?>
            <importResponse xmlns="http://ldbv.bayern.de/baybw/upload/onlinedienste/v1">
                <resultInfo>
                    <message>
                    Die hochgeladene Datei wurde nicht verarbeitet.
            
                    Bitte prüfen Sie, ob der http-header Content-Type: application/xml gesetzt ist 
                    und ob die hochgeladene XML-Datei im Bezug auf das geforderte Schema valide ist. 
                    Bei Validierungsfehlern wird nur die erste Fehlerstelle angezeigt.
            
                    org.xml.sax.SAXParseException; lineNumber: 23; columnNumber: 75; 
                    cvc-pattern-valid: Value '9561000' is not facet-valid 
                    with respect to pattern '[0-9][0-9][0-9][0-9][0-9][0-9][0-9][0-9]' 
                    for type '#AnonType_mandantGemeindeschluesselOnlinedienstType'.
                    </message>
                </resultInfo>
            </importResponse>
            

Schritt 2: Validierung der Daten vor dem Import

Wenn die hochgeladene XML-Datei in Bezug auf das XML-Schema valide ist, werden die Daten für die weitere Verarbeitung in der Datenbank des Redaktionssystems zwischengespeichert. Anschließend erfolgt dann die technische Validierung. Dieser Schritt ist vom synchronen Hochladen der XML-Datei entkoppelt, weil die Prüfung aufwändiger ist, als die reine Schema-Validierung.

Wenn bei der technischen Prüfung keine Validierungsfehler auftreten, erhält der Absender eine positive Bestätigung per E-Mail. Damit ist für den Absender das Hochladen erfolgreich abgeschlossen. Die Daten werden dann in weiteren Schritten weiterverarbeitet.

Wenn bei der technischen Validierung Validierungsfehler auftreten, wird der Import vollständig zurückgewiesen. Eine teilweise Verarbeitung findet nicht statt. Der Absender erhält eine E-Mail, in der die Fehler im Detail beschrieben werden. Die zwischengespeicherten Daten dieses Imports werden nicht weiterverarbeitet.

Die folgende Tabelle zeigt, welche Elemente bei der Schema-Validierung (S) und/oder im Rahmen der technischen Validierung (T) geprüft werden. Fehler die bei der Validierung festgestellt werden, muss der Absender beheben.

Fehlermeldungen die bei der Schema-Validierung (S) entstehen, sind vom XML-Parser abhängig und werden in Englisch erzeugt. Sie sind in der Spalte "Mögliche Fehlermeldungen/Warnmeldungen" nicht wörtlich, sondern sinngemäß wiedergegeben. IT-Dienstleister, die einen Upload per Web-Service-Client programmieren, können mit diesen Meldungen umgehen.

Beispiel:
Titel eines Dienstes hat im Upload mehr als 256 Zeichen

Schema-Parser:

org.xml.sax.SAXParseException; lineNumber: 33; columnNumber: 357; cvc-maxLength-valid: Value 'xxx...xxx' with length = '334' is not facet-valid with respect to maxLength '256' for type '#AnonType_odTitelOnlinedienstType'.

Sinngemäß in der Spalte "Mögliche Fehlermeldungen/Warnmeldungen"

Der Titel des Dienstes darf nicht mehr als 256 Zeichen haben. (S)

Bitte beachten Sie, dass wenn eine leere Datei hochgeladen wird, alle früher importierten Online-Dienste gelöscht werden.

Weitere Schritte: Übernahme und Veröffentlichung der Daten

Die erfolgreich hochgeladenen Daten werden in das Redaktionssystem übernommen und von der Zentralen Redaktion Leistungen und Übersichtsseiten zugeordnet. Die Online-Dienste werden dann im BayernPortal bei der entsprechenden Leistungsbeschreibung verlinkt. Im BayernPortal werden sie außerdem auf der Behördenseite unter "Online-Verfahren" und auf den regionalen Übersichtseiten für gleichartige Online-Dienste, die über das Menü "Übersicht" - "Online-Verfahren" aufrufbar sind, verlinkt.

Vor jedem Import wird geprüft, ob die Daten bereits im Redaktionssystem vorhanden sind. Wenn ein Online-Verfahren z. B. aus einem früheren Import vorhanden ist und vom Redakteur der Behörde nicht manuell bearbeitet wurde, werden Titel und Beschreibung ggf. aktualisiert. Neue Online-Dienste werden automatisch angelegt und nicht mehr vorhandene Online-Dienste werden automatisch gelöscht. Bei Bedarf werden auch regionale Ergänzungen für Leistungen angelegt, aktualisiert oder gelöscht. Wenn eine regionale Ergänzung nicht durch den Redakteur manuell bearbeitet wurde, wird das Gültigkeitsdatum bei jedem Import verlängert.

Die Behörden für die Online-Dienste importiert wurden, werden nach jedem Import informiert.

• Startseite
• Impressum
• Datenschutzerklärung
• Kontakt
• © Bayerisches Staatsministerium für Digitales
• Version: 8.1.2 vom 15.04.2024