1.0.0
Name der Organisationseinheit
| Fachliche Kategorie | Technische Kategorie |
|---|---|
| Stammdaten der zuständigen Organisationseinheit und ihrer Formulare | XZuFi-basierte Parameter ohne direkten Onlinedienst-Bezug |
Fachliche Bedeutung
Name bzw. Bezeichnung 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 ein oder mehrere Elemente enthalten, die ebenfalls name heißen. Die inneren name-Elemente sind jeweils eine internationalisierte Zeichenkette.
Jedes äußere 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 äußeres name-Element gibt. Ein Onlinedienst, der für einen Zeitpunkt mehrere gültige äußere 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
- 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">Bundesministerium für Umwelt, Naturschutz und nukleare Sicherheit</xzufi:name>
<xzufi:name languageCode="en">Federal Ministry for the Environment, Nature Conservation and Nuclear Safety</xzufi:name>
<xzufi:gueltigkeit>
<xzufi:beginn>2018-03-14</xzufi:beginn>
<xzufi:ende>2021-12-07</xzufi:ende>
</xzufi:gueltigkeit>
</xzufi:name>
<xzufi:name>
<xzufi:name languageCode="de">Bundesministerium für Umwelt, Naturschutz, nukleare Sicherheit und Verbraucherschutz</xzufi:name>
<xzufi:name languageCode="en">Federal Ministry for the Environment, Nature Conservation, Nuclear Safety and Consumer Protection</xzufi:name>
<xzufi:gueltigkeit>
<xzufi:beginn>2021-12-08</xzufi:beginn>
<xzufi:ende>9999-12-31</xzufi:ende>
</xzufi:gueltigkeit>
</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 als name[]:name[] den Namen der Organisationseinheit als internationalisierte Zeichenkette.
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[]:destinationName den Namen der Organisationseinheit als einfache (i.e. nicht als internationalisierte) Zeichenkette in deutscher Sprache.
Die FIT-Connect Routing API übernimmt den Wert für route[]:destinationName zum Stand Q2/2024 aus dem Element title aus der Response eines Aufrufs des Endpunktes /v4/organisationunits/detail (öffnet in neuem Tab) der PVOG-Suchdienst API. Diese API wertet die Gültigkeiten der äußeren name-Elemente der Organisationseinheit nicht aus. Daher kann das Ergebnis nicht-deterministisch sein, wenn eine Organisationseinheit zwei verschiedene äußere name-Elemente hat, auch wenn von denen zu jedem Zeitpunkt nur eines gültig ist.
Ermittlungsmöglichkeit DVDV API
(Der Parameter kann nicht über das DVDV-API ermittelt werden)
Best Practices
(keine Empfehlungen)