Zum Hauptinhalt springen
Version

1.0.0

Kurzbezeichnung der Organisationseinheit

Fachliche KategorieTechnische Kategorie
Stammdaten der zuständigen Organisationseinheit und ihrer FormulareXZuFi-basierte Parameter ohne direkten Onlinedienst-Bezug

Fachliche Bedeutung​

Kurzbezeichnung der Organisationseinheit

Wertemenge​

Menge von internationalisierten Zeichenketten jeweils mit Gültigkeitszeitraum

Verortung im Datenmodell​

Das Datenobjekt Organisationseinheit hat ein oder mehrere Elemente name, die selbst wieder mehrere optionale Elemente enthalten, die kurzbezeichnung heißen. Diese bilden jeweils eine internationalisierte Zeichenkette.

warnung

Jedes name-Element hat einen optionalen Gültigkeitszeitraum. Um ein eindeutiges und deterministisches Verhalten der Onlinedienste zu bewirken, muss die Redaktion sicherstellen, dass es für jeden Zeitpunkt genau ein gültiges name-Element gibt. Ein Onlinedienst, der für einen Zeitpunkt mehrere gültige name-Elemente vorfindet, muss eines dieser Elemente auswählen. Dabei hat der Onlinedienst keine Selektions-Kriterien zur Verfügung, so dass seine Auswahl zufällig erscheinen muss. Tritt dieses Ereignis ein, sollte der Onlinedienst eine entsprechende Warnung loggen, dass hier vermutlich eine Fehlkonfiguration vorliegt.

Codebeispiel XZuFi 2.2​

info
  • Das folgende Codebeispiel zeigt nicht alle Features des äußeren name-Elements.
    <xzufi:organisationseinheit p3:type="xzufi:OrganisationseinheitErweitert" xmlns:p3="http://www.w3.org/2001/XMLSchema-instance">

      <xzufi:name>
        <xzufi:name languageCode="de">Behörde für Wirtschaft und Innovation</xzufi:name>
        <xzufi:name languageCode="en">Authority for Economy and Innovation</xzufi:name>
        <xzufi:kurzbezeichnung languageCode="de">Behörde für Wirtschaft und Innovation</xzufi:kurzbezeichnung>
        <xzufi:kurzbezeichnung languageCode="en">Authority for Economy and Innovation</xzufi:kurzbezeichnung>
      </xzufi:name>

    </xzufi:organisationseinheit>

Ermittlungsmöglichkeit PVOG API​

Zunächst muss das zuständige Organisationseinheit-Datenobjekt ermittelt werden. Siehe dazu Abschnitt Ermittlung eines zuständigen Organisationseinheit-Datenobjektes mit Hilfe der PVOG-API.

Die Response, die der Endpunkt /v2/organisationunits/jzufi (öffnet in neuem Tab) zurückgibt, enthält ein Element name[], das die Menge der Namen (jeweils mit Gültigkeitszeiträumen) enthält. Der Onlinedienst muss dasjenige name[]-Element identifizieren, bei dem name[]:gueltigkeit nicht vorhanden ist oder dessen name[]:gueltigkeit:beginn und name[]:gueltigkeit:ende-Elemente den gewünschten Zeitpunkt umschließen.

Das so identifizierte name[]-Element enthält ein Element name[]:kurzbezeichnung[], das die Kurzbezeichnung der Organisationseinheit als internationalisierte Zeichenkette enthält.

Ermittlungsmöglichkeit FIT-Connect Routing API​

Der Onlinedienst benutzt den Endpunkt /routes mit den URL-Parametern zur Identifikation des gesuchten Adressaten, z.B. leikaKey = <LeikaId der Leistung> und ars = <ARS des gesuchten Gebiets> und erhält eine JSON-Datenstruktur als Response.

In dieser Datenstruktur enthält das Element route[]:destinationShortName die Kurzbezeichnung der Organisationseinheit als einfache (i.e. nicht als internationalisierte) Zeichenkette.

gefahr

Stand Q2/2024 wird der Wert des Elements route[]:destinationShortName von der FIT-Connect Routing API nicht korrekt gefüllt. Statt der aktuell gültigen Kurzbezeichnung enthält das Element die Kurzbeschreibung. Ein entsprechender Bug-Report wurde erfasst und soll korrigiert werden.

Ermittlungsmöglichkeit DVDV API​

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

Best Practices​

(keine Empfehlungen)