Datentyp Onlinedienst

In der untenstehenden Tabelle ist die Ausgabe über die API sowie im Suchclient beschrieben.

Tabelle durchsuchen

id (type = xzufi:Identifikator)	Primäre ID	Ja	Nein
idSekundaer (type = xzufi:Identifikator)	Sekundäre IDs	Nein	Nein
bezeichnung (type = xzufi:String.Localized)	Bezeichnung des Onlinedienstes	Ja	Ja
kurzbezeichnung (type = xzufi:String.Localized)	Kurze Bezeichnung des Onlinedienstes, z. B. eine Abkürzung	Nein	Nein
beschreibung (type = xzufi:String.Localized)	Allgemeine Beschreibung des Onlinedienstes. Die Verwendung bestimmter HTML-Auszeichnungen (siehe Spezifikation) ist hier gestattet.	Ja	Ja
teaser (type = xzufi:String.Localized)	Teaser-Text des Onlinedienstes, um ihn z. B. in Suchergebnislisten kurz zu erläutern.	Ja	Nein
link (type = xzufi:OnlinedienstLink)	URL zum Onlinedienst inklusiver aller Parameter. Vorhandene dynamische Parameter müssen zusätzlich angehangen werden. Siehe dazu auch das folgende Kapitel Dynamische Parameter	Ja	Ja	API: Übertragen via JZuFi
parameter (type = xzufi:OnlinedienstParameter)	Parameter zur Konfiguration des Dienstes. Achtung: Hierbei handelt es sich nicht um URL-Parameter. Die hier hinterlegten Parameter dürfen also insbesondere nicht an die URLs zu den Diensten angehängt werden. Dieses Element kann übermittelt werden, falls eine separate Betrachtung von Parametern im Anwendungsfall wichtig ist.	Ja	Nein
durchfuehrungStaatsangehoerigkeit (type = xzufi:Code.StaatsangehoerigkeitDestatis)	Angabe der zur Inanspruchnahme des Dienstes möglichen Staatsangehörigkeiten	Ja	Ja	Ggf. Anzeige einer Meldung nur im Negativfall, wenn es Beschränkungen gibt.
durchfuehrungSprachen (type = xzufi:Sprache)	Angabe der Sprachen, in welchen der Onlinedienst durchgeführt bzw. in Anspruch genommen werden kann.	Ja	Ja	Ggf. ausgeben als Hinweismeldung?
zahlungsweise (type = xzufi:Code.Zahlungsweise)	Verfügbare Zahlungsweisen für den Onlinedienst	Nein	Nein	Erwartungshaltung: Detailbeschreibung OD auf Ziel-Portalseite
vertrauensniveau (type = xzufi:Code.Vertrauensniveau)	Angabe des Vertrauensniveaus (Level of Assurance)	Nein	Nein
Identifizierungsmittel (type = xzufi:Code.Identifizierungsmittel)	Angabe der zulässigen Identifizierungsmittel für den Onlinedienst.	Nein	Nein
logo (type = xzufi:Identifikator)	Logo des Onlinedienstes als Referenz. Die Logo-Datei kann mittels der Nachricht allgemein.anfrage|antwort.datei abgefragt bzw. übermittelt werden"	Nein	Nein
hilfeLink (type = xzufi:HyperlinkErweitert)	Angabe von Links zu Hilfe-Ressourcen zum Onlinedienst.	Nein	Nein
hilfeText (type = xzufi:String.Localized)	Kurze Beschreibung zu Hilfe-Ressource.	Nein	Nein
herausgeber (type = xzufi:Herausgeber)	Optionale Angabe des Herausgebers der Daten	Nein	Nein
versionsinformation (type = xzufi:Versionsinformation)	Informationen zur Versionierung	Nein	Nein
sprachversion (type = xzufi:Sprachversion)	Angabe aller verfügbaren Sprachversionen des Objekts. Achtung: Dies betrifft nur die Metadaten der aktuellen Klasse und ist nicht zu verwechseln, in welchen Sprachen der Onlinedienst abgewickelt werden kann.	Ja	Nein
gueltigkeit (type = xzufi:Zeitraum)	Gültigkeit definiert die Zeiträume, in denen das Objekt gültig ist. Zeiträume können nacheinander liegen oder sich überschneiden.	Nein	Nein	Suchdienst-interne Relevanz
zustaendigkeit (type = xzufi:Zustaendigkeit)	Angabe der Zuständigkeiten des Onlinedienstes (nur OnlinedienstErweitert)	Nein	Nein	Ignorieren, sofern die Zuständigkeit bei Organisationseinheit verwendet wird.

Dynamische Parameter

• Der XZuFi-Standard erlaubt das Parametrisieren von Onlinedienst-URLs durch zusätzliche dynamische Query-Parameter. Wie die dynamischen Parameter zu übertragen sind, ist im Sammlerdienst-Konzept (öffnet in neuem Tab, Download) unter dem Punkt Parametrisierung von Online-Dienst-URLs ausführlich beschrieben.
• Der Suchdienst kann die von den Redaktionssystemen ans PVOG übertragenen dynamischen Parameter interpretieren und Onlinedienst-Links um die enthaltenen Werte erweitern. Das Suchdienst-Frontend stellt lediglich schon parametrisierte Links dar.

Unterstützte dynamische Parameter

Aktuell unterstützt der Suchdienst ausschließlich vier Typen von dynamischen Parametern (die ersten vier Einträge aus den Codelisten urn:xoev-de:fim:codeliste:xzufi.dynamischerparametertyp für XZuFi-2.3.1 und urn:xoev-de:fim:codeliste:xzufi.onlinedienstdynamischerparametertyp für XZuFi-2.2.0):

• ID einer Leistung - Codelisten-Eintrag 001
• 12-stelliger ARS (Amtlicher Regionalschlüssel) aus der Zuständigkeit des Onlinedienstes (wird immer als ARS interpretiert, selbst wenn der Parameternamen anders lautet) - Codelisten- Eintrag 002
• ID einer Organisationseinheit, die für denselben ARS zuständig ist - Codelisten-Eintrag 003 -Leistungsschlüssel - Codelisten-Eintrag 004

Aktivierung in der API

• Dynamische Parameter werden nur berechnet, wenn das API mit applyDynamicParams=true aufgerufen wird.
• Beispiel (öffnet in neuem Tab)
• applyDynamicParams=true aktiviert die Ergänzung; false (Default) liefert die Original-Links aus den Quelldaten.