Zum Hauptinhalt springen
Version

1.0.0

idOnlinedienstGlobal

Fachliche KategorieTechnische Kategorie
Onlinedienst-bezogener StandardparameterXZuFi-basierte Standard-Parameter mit direktem Onlinedienst-Bezug

Fachliche Bedeutung​

Der Wert des Parameters idOnlinedienstGlobal identifiziert das Onlinedienst Produkt, d.h. das Software-System, und dessen Version, für die das Parameter-Set im Redaktionssystem erstellt worden ist.

Dieser Parameter wird für das Konzept zur Versionierung von Onlinedienst Produkten benötigt.

Wertemenge​

Datentyp URN, im XZuFi codiert mit einer Zeichenkette, die den Regeln des URN-Encoding entsprechen

Verortung im Datenmodell​

Siehe Abschnitt Verortung von generischen XZuFi-basierten Standard-Parametern mit direktem Onlinedienst-Bezug im PVOG Datenmodell. Der Namens-Schlüssel ist "efa.custom.idOnlinedienstGlobal".

Codebeispiel XZuFi 2.2​

<xzufi:onlinedienst xmlns:p3="http://www.w3.org/2001/XMLSchema-instance"
    p3:type="xzufi:OnlinedienstErweitert">
    
      <xzufi:parameter>
        <xzufi:parameterName>efa.custom.idOnlinedienstGlobal</xzufi:parameterName>
        <xzufi:parameterWert>urn:schleswig-holstein:de:wohngeld:dataport:1.0</xzufi:parameterWert>
      </xzufi:parameter>

</xzufi:onlinedienst>
info

Der Namens-Schlüssel efa.custom.idOnlinedienstGlobal soll bewusst nicht Teil des XZuFi 2.3 Standard-Vorschlags für die Code-Liste urn:xoev-de:fim:codeliste:xzufi.efaparameter werden, da in XZuFi 2.3 ein nicht-generische XZuFi-basierte Standard-Parameter mit direktem Onlinedienst-Bezug in Form des Elements Onlinedienst.idOnlinedienstGlobal vorhanden sein wird, wo der Parameter dann verortet sein wird. Der Namens-Schlüssel soll dann nicht mehr verwendet werden.

Der Namens-Schlüssel wurde bewusst mit dem Präfix efa.custom. festgelegt, damit der Wert über die aktuelle Implementierung der FIT-Connect Routing API ausgelesen werden kann.

Ermittlungsmöglichkeit PVOG API​

Siehe Abschnitt Ermittlung von generischen XZuFi-basierten Standard-Parametern mit direktem Onlinedienst-Bezug mit Hilfe der PVOG-API. Der Namens-Schlüssel ist "efa.custom.idOnlinedienstGlobal".

Ermittlungsmöglichkeit FIT-Connect Routing API​

Bis zur Migration nach XZuFi 2.3 kann der Parameter wie jeder XZuFi-basierten Individual-Parameter mit direktem Onlinedienst-Bezug über das FIT-Connect Routing-API ausgelesen werden, da er sich an die FIT-Connect Namenskonvention für diese Parameter hält. Der Wert ist in der Response des /routes-Endpunktes im Element customParameters:efa.custom.idOnlinedienstGlobal zu finden.

info

Nach einer vollständigen Migration nach XZuFi 2.3 wird es voraussichtlich eine Möglichkeit geben, den Parameter auch über die FIT-Connect Routing API zu ermitteln. Diese Möglichkeit muss aber erst noch spezifiziert werden.

Ermittlungsmöglichkeit DVDV API​

(Der Parameter kann nicht über das DVDV-API ermittelt werden)

Best Practices​

Siehe Versionierung von Onlinedienst Produkten