Online-Dienst

Identifikation von Online-Diensten

Die Identifikation eines Online-Diensts (Abschnitt: <xzufi:onlinedienst>) erfolgt über das Element <xzufi:id> (siehe auch Abschnitt „Eindeutige Identifikation von Objekten“).

Beispiel (Online-Dienst aus Hamburg)

<xzufi:transfer.operation.050502>
    …
    <xzufi:onlinedienst>
        …
        <xzufi:id schemeAgencyID="S100002">
            S1000020030000002289
        </xzufi:id>
        …
    </xzufi:onlinedienst>
    …
</xzufi:transfer.operation.050502>

Beschreibung von Online-Diensten

Die Beschreibung von Online-Diensten erfolgt über die unterschiedlichen Elemente des Datentyps <xzufi:onlinedienst>. Beispielsweise wird, die URL für einen Online-Dienst über das Element <xzufi:link> angegeben.

Beispiel (Online-Dienst aus Hamburg)

<xzufi:transfer.operation.050502>
    …
    <xzufi:schreibe>
        …
        <xzufi:onlinedienst>
            …
            <xzufi:teaser languageCode="de">
                Sie können ein Gewerbe auch online anmelden.
            </xzufi:teaser>
            <xzufi:link languageCode="de">
                <xzufi:typ
                    listURI="urn:xoev-de:fim:codeliste:onlinedienstlinktyp"
                    listVersionID="1">
                    <code>01</code>
                </xzufi:typ>
                <xzufi:link>
                    https://musterbundesland.de/onlineservices/gewan
                </xzufi:link>
                <xzufi:titel languageCode="de">
                    Gewerbemeldung Online
                </xzufi:titel>
                <xzufi:beschreibung>
                    Gewerbemeldung Online
                </xzufi:beschreibung>
                <xzufi:positionDarstellung>1</xzufi:positionDarstellung>
            </xzufi:link>
        </xzufi:onlinedienst>
    </xzufi:schreibe>
</xzufi:transfer.operation.050502>

Aufgrund der Tatsache, dass die Angabe der URL im Element <xzufi:link> vom Typ xs.anyURI erfolgt und an dieser Stelle keine Mehrsprachigkeit unterstützt wird, müssen bei der Verwendung unterschiedlicher URLs für unterschiedliche Sprachen entweder das gesamte Element <xzufi:link> vom Typ xzufi:OnlinedienstLink mehrfach verwendet werden (siehe Beispiel unten) oder Parameter genutzt werden (siehe Abschnitt „Parametrisierung von Online-Dienst-URLs“).

Beispiel (Online-Dienst aus Hamburg)

<xzufi:onlinedienst>
    …
    <xzufi:link languageCode="de">
        <xzufi:typ
            listURI="urn:xoev-de:fim:codeliste:onlinedienstlinktyp"
            listVersionID="1">
            <code>01</code>
        </xzufi:typ>
        <xzufi:link>
            https://musterbundesland.de/onlineservices/de/gewan
        </xzufi:link>
        …
    </xzufi:link>
    <xzufi:link languageCode="en">
        <xzufi:typ
            listURI="urn:xoev-de:fim:codeliste:onlinedienstlinktyp"
            listVersionID="1">
            <code>01</code>
        </xzufi:typ>
        <xzufi:link>
            https://musterbundesland.de/onlineservices/en/gewan
        </xzufi:link>
        …
    </xzufi:link>
</xzufi:onlinedienst>

Darstellung Online-Dienst am Beispiel Bayern Portal

Parametrisierung von Online-Dienst-URLs

Bei der Parametrisierung von Online-Diensten muss in XZuFi zwischen zwei verschiedenen Arten von Parametern unterschieden werden:

• Statische Parameter
• Dynamische Parameter

Bei statischen Parametern werden Schlüssel-Wert-Paare übertragen, die genauso auch beim Aufruf der URL mitgegeben werden. Statische Parameter müssen mit der URL des Online-Dienstes im Element <xzufi:link> übergeben werden.

Beispiel

<xzufi:onlinedienst>
    …
    <xzufi:link languageCode="de">
        <xzufi:link>
        https://musterbundesland.de/onlineservices/gewan?lang=de&amp;country=DE
        </xzufi:link>
        …
    </xzufi:link>
    …
</xzufi:onlinedienst>

Bei der Verwendung von dynamischen Parametern, werden vordefinierte Schlüssel verwendet, die anschließend mit Werten aus dem Kontext, in dem der Online-Dienst verwendet wird, belegt werden. Die Tabelle wird für alle zugelassenen dynamischen Parameter angegeben, ob diese im Kontext der PVOG-Suche unterstützt werden.

Parameter	Code	Auswertung im Standard-Such-Client
Leistung	001	Ja
Gebiet	002	Ja
Organisationseinheit	003	Nein, da keine eindeutige Zuordnung von Online-Diensten zu Organisationseinheiten möglich.
Leika-Leistung	004	Ja
Formular	005	Nein, da keine eindeutige Zuordnung von Online-Diensten zu Formularen möglich ist.
Sprache	006	Ja

Dynamische Parameter, die vom PVOG in der Suchfunktion nicht unterstützt werden, können in der Datenlieferung trotzdem angegeben werden.

Beispiel

<xzufi:onlinedienst>
    …
    <xzufi:link languageCode="de">
        <xzufi:link>
        https://musterbundesland.de/onlineservices/gewan
        </xzufi:link>
        <xzufi:dynamischeParameter>
            <xzufi:typ
             listURI="urn:xoevde:
             fim:codeliste:xzufi.onlinedienstdynamischerparametertyp"
             listVersionID="1">
                <code>006</code>
            </xzufi:typ>
            <xzufi:parametername>lang</xzufi:parametername>
        </xzufi:dynamischeParameter>
        <xzufi:dynamischeParameter>
            <xzufi:typ
             listURI="urn:xoevde:
             fim:codeliste:xzufi.onlinedienstdynamischerparametertyp"
             listVersionID="1">
                <code>002</code>
            </xzufi:typ>
            <xzufi:parametername>ars</xzufi:parametername>
        </xzufi:dynamischeParameter>
        …
    </xzufi:link>
</xzufi:onlinedienst>

Das Suchdienstkonzept enthält eine detaillierte Übersicht, wie das Online-Gateway mit dynamischen Parametern im Such-Client umgeht.

Aus dem obigen Beispiel würde im Kontext einer Leistungssuche im PVOG-Such-Client über eine deutschsprachige Benutzerschnittstelle für Musterstadt mit dem ARS 123456789012 zum Beispiel die folgende URL zusammengebaut werden:

https://musterbundesland.de/onlineservices/gewan?lang=de&ars=123456789012

Der Aufruf des Online-Dienstes über die angegebenen URL muss immer (auch ohne Angabe der Parameter) möglich sein und darf aufseiten des Online-Dienstes nicht dazu führen, dass der Online- Dienst vom Nutzer nicht verwendet werden kann.

Achtung

Der Datentyp <xzufi:OnlineDienst> enthält auch das Element <xzufi:parameter> vom Datentyp <xzufi:OnlineDienstParameter>. Dieses Element ist für die Übertragung von Online-Dienst-Konfigurationsdaten gedacht, die nicht per URL übertragen werden sollen oder können (z. B. aufgrund von Größenbeschränkungen oder Sicherheitsüberlegungen). Dieses Element wird im Online-Gateway nicht weiter ausgewertet, kann von nachgelagerten Systemen aber über die Bereitstelldienst-API oder die Suchdienst-API abgerufen werden.

Zuordnung Online-Dienst / Verwaltungsleistung

Im Redaktionssystem muss sichergestellt sein, dass für alle Teilgebiete des Gültigkeitsbereichs einer Leistung (siehe auch Abschnitt „Regionale Gültigkeit von Verwaltungsleistungen“) mindestens ein zuständiger Online-Dienst oder eine zuständige Organisationseinheit existiert, damit es im Rahmen der Ermittlung der zuständigen Stelle nicht zu einer Leistungsdarstellung ohne Kontaktinformationen kommt.

Die Zuordnung eines Online-Diensts zu einer Verwaltungsleistung erfolgt im Datentyp <xzufi:OnlinedienstErweitert> über das Element <xzufi:zustaendigkeit>. Ein Online-Dienst kann mehreren Verwaltungsleistungen zugeordnet werden.

Beispiel

<xzufi:transfer.operation.050502>
    …
    <xzufi:schreibe>
        …
        <xzufi:onlinedienst xsi:type="xzufi:OnlinedienstErweitert">
            …
            <xzufi:zustaendigkeit>
                …
                <xzufi:leistungID schemeAgencyID="S100002">
                S1000020010000006848
                </xzufi:leistungID>
            </xzufi:zustaendigkeit>
        </xzufi:onlinedienst>
    </xzufi:schreibe>
</xzufi:transfer.operation.050502>