Link zur Startseite

Webservice zur Übertragung von Daten über kommunale Online-Dienste in das Verwaltungsinformationssystem Bayern (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.baybw-redaktion.bayern.de) zu erfassen und bei den entsprechenden Leistungen zu verlinken. Es besteht außerdem noch immer die Möglichkeit, die Daten zu eGovernment-Angeboten über einen Import-Webservice automatisiert (z. B. aus einer dezentralen Datenbank) zu importieren und zu veröffentlichen. Es können nicht nur Zuordnungen von Online-Verfahren zu Leistungen importiert werden sondern auch sonstige Daten der Behörde (z. B. Informationen zu Organisationseinheiten und Ansprechpartner, Zuordnungen von Leistungen zu Organisationseinheiten). 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-Service-Übersichten zugänglich sein. Es ist immer erkennbar, welche Kommune den Online-Dienst anbietet.

Technische und organisatorische Angaben (Überblick)

Merkmal Erläuterung
Übertragungsprotokoll HTTP(S) POST
Dateiformat XML-Datei (Content-Type: application/xml)
XML-Schema (Inhaltsmodell) Die hochzuladende XML-Datei muss in Bezug auf das XML-Schema upload-onlinedienste.xsd valide sein.
Beispiele Zur Veranschaulichung hier eine erfolgreich validierbare Upload-Datei aus der Praxis:
Authentifizierung erforderlich (Basic-Authentication)
URL https://www.baybw-services.bayern.de/rest/onlinedienste/upload
Zugangsdaten Die Zugangsdaten für die Nutzung dieses Upload-Webservices erhalten Sie als IT-Dienstleister bei der Zentralen Redaktion (bayvws-redaktion@stmi.bayern.de) beantragen.
Technische Fragen IT-Dienstleister können über die E-Mail-Adresse bayernportal-webservice-support@ldbv.bayern.de konkrete technische Fragen an Landesamt für Digitalisierung, Breitband und Vermessung - IT Dienstleistungszentrum Bayern stellen.

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)

Element Typ Beschreibung / Bedeutung Mögliche Fehlermeldungen/Warnmeldungen
odKennung Pflichtfeld, max. 256 Zeichen Eindeutige Kennung des Online-Dienstes, die vom IT-Dienstleister vergeben wird.

Über die Kennung erfolgt die Zuordnung der Online-Dienste im Redaktionssystem.

Die Kennung des Dienstes darf nicht leer sein. (S und T)

Die Kennung des Dienstes darf nicht mehr als 256 Zeichen haben. (S)

odTitel Pflichtfeld, max. 256 Zeichen Sprechende Bezeichnung bzw. Titel des Online-Dienstes, der vom IT-Dienstleister vergeben wird.

Titel des Online-Dienstes im Bereich des Absenders. Wenn der gleiche Dienst vom Absender für verschiedene Mandanten angeboten wird, sollte der Titel für jeden Mandanten identisch sein. Der Name der Behörde darf im Titel nicht vorkommen, da er auf den Seiten unseres Portals bei Bedarf automatisch hinzugefügt wird.

Der Titel wird im BayernPortal veröffentlicht und als Linktext oder Seitenüberschrift angezeigt.

Der Titel des Dienstes darf nicht leer sein. (S und T)

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

Online-Dienste mit der gleichen Kennung müssen auch den gleichen Titel haben. (T)

Diesem Online-Dienst sind verschiedene Titel zugeordnet. Falls der Name der Behörde im Titel des Online-Dienstes enthalten ist, entfernen Sie diesen bitte, da er auf den Seiten unseres Portals bei Bedarf automatisch hinzugefügt wird. Bitte wiederholen Sie den Upload nach der Korrektur. (T)

odBeschreibung Pflichtfeld, max. 512 Zeichen Kurze Beschreibung des Online-Dienstes (ca. 1-3 Sätze). Es muss über den Titel hinaus kurz erläutert werden, was der Online-Dienst dem Benutzer bietet.

Die Beschreibung muss benutzerfreundlich, allgemeinverständlich und anbieterneutral formuliert sein.

Beispiel:

"Gewerbetreibende haben die Möglichkeit, ihre Gewerbemeldungen online zu erfassen und an die zuständige Behörde zu übermitteln."

Die Beschreibung wird BayernPortal veröffentlicht und unter dem verlinkten Titel oder der Seitenüberschrift angezeigt.

Die Beschreibung des Dienstes darf nicht leer sein.(S und T)

Die Beschreibung des Dienstes darf nicht mehr als 512 Zeichen haben. (S)

odUrl Pflichtfeld, max. 512 Zeichen Eindeutige und absolute Webadresse des Online-Dienstes.

Im Rahmen der technischen Validierung wird auch geprüft, ob die URL erreichbar ist.

Die URL 'xxxxx' des Dienstes darf nicht leer sein. (S)

Die URL des Online-Dienstes ist nicht erreichbar. (HTTP-Statuscode: 401 - Unauthorized) (T)

odKategorie Pflichtfeld Kategorie des Online-Dienstes
  • Online-Verfahren [ONLINEVERFAHREN] = Dienst, der eine Online-Übermittlung von Daten ermöglicht.
  • Formular [FORMULAR] = Dienst, der keine Übermittlung von Daten ermöglicht. Über das Formblatt oder einen Assistenten können die Daten online erfasst werden. Das Formular muss jedoch ausgedruckt oder zwischengespeichert werden und per Post oder verschlüsselter E-Mail an die zuständige Behörde gesendet werden. Dienste diese Kategorie werden nicht über diese importiert; sie müssen ggf. von der Behörde manuell gepflegt werden.
  • Kategorie nicht bekannt [INFORMATION_NICHT_VERFUEGBAR] = Wenn nicht bekannt, ob Online-Verfahren oder Formular, wird der Online-Dienst nicht importiert.
Es werden nur Online-Verfahren importiert.
Hier sind nur folgende Werte zulässig: (S)
  • ONLINEVERFAHREN
  • FORMULAR
  • INFORMATION_NICHT_VERFUEGBAR

Dienste der Kategorie 'FORMULAR' und 'INFORMATION_NICHT_VERFUEGBAR' werden nicht verarbeitet. (T)

mandantKennung Pflichtfeld, max. 256 Zeichen Kennung des Mandanten (z.B. der Gemeinde) für den der IT-Dienstleister den Online-Dienst anbietet (wird vom IT-Dienstleister vergeben)

Die Kennung des Mandanten darf nicht leer sein. (S und T)

Die Kennung des Mandanten darf nicht mehr als 256 Zeichen haben. (S)

mandantDienststellennummer Pflichtfeld, genau 7 Ziffern Dienststellennummer der Behörde, für die der IT-Dienstleister den Online-Dienst anbietet.

Die aktuellen Dienststellennummern kommunaler Behörden werden dem IT-Dienstleister auf Anfrage von der Zentralen Redaktion (bayvws-redaktion@stmi.bayern.de) zur Verfügung gestellt.

Die Dienststellennummern der Kommunen ändern sich selten. Sie eignen sich daher als Schlüssel, um die Dienststelle zu identifizieren, in deren Auftrag der IT-Dienstleister den Online-Dienst zur Verfügung stellt.

Beim Import eines Online-Dienstes in die Datenbank des Redaktionssystems wird - anhand der Dienststellenummer die Behörde zugeordnet, die das Online-Verfahren anbietet.

Bei der Anlage der regionalen Ergänzungen, wird die Dienststellennummer herangezogen, um die redaktionell verantwortliche Behörde zu hinterlegen und den regionalen Zuständigkeitsbereich zu ermitteln.

Die Dienststellennummer des Mandanten darf nicht leer sein. (S und T)

'xxxxxxx' ist keine gültige Dienststellennummer eines Mandanten. (T)

Die Dienststellennummer muss aus 7 Ziffern bestehen. (T)

mandantGemeindeschluessel Optionales Feld; wenn geliefert, dann genau 8 Ziffern mit führender '0'. Amtlicher Gemeindeschlüssel (AGS), den der IT-Dienstleister mit einem Mandanten verknüpft hat.

Wird derzeit nicht geprüft und auch nicht weiterverwendet (für zukünftige Belange reserviert).

Der Gemeindeschlüssel muss aus 8 Ziffern bestehen und muss mit 0 beginnen. (T)
Allgemeine Prüfungen für den gesamten Import Es wird geprüft, ob je Dienst und Behörde nur ein Datensatz geliefert wird. Die Kombination aus Kennung des Dienstes und Dienststellennummer dürfen in einer Importdatei nur einmal vorkommen. Dieser Online-Dienst ist für diese Behörde mehrfach vorhanden. (T)

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-Services" und auf den regionalen Übersichtseiten für gleichartige Online-Dienste, die über das Menü "Übersicht" - "Online-Services" 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.