Version

1.0.0

Ermittlung der ID der Leistungsbeschreibung

Die PVOG-Suchdienst-API benötigt in der Regel die ID einer Leistungsbeschreibung, die sich aus der LeikaID und Gültigkeitsgebiet (ARS) ermitteln lässt.

Der Onlinedienst benutzt dazu den Endpunkt /v3/servicedescriptions/leikaid (öffnet in neuem Tab) mit dem URL-Parameter leikaIds = <die LeikaID> und ars = <der ARS>. Zusätzlich muss der Onlinedienst einen validDate URL-Parameter angeben, um die Angaben auf oberster Ebene auf diejenigen Elemente zu beschränken, die zum angegebenen Zeitpunkt (in der Regel das Datum der Antragstellung) gültig sind.

Die Response enthält im Element content[] ein Array mit den Daten passender Leistungsbeschreibung-Datenobjekten. Falls an dieser Stelle mehrere solche Datenobjekte vorhanden sind, muss dasjenige identifiziert werden, das am besten zu den aktuellen Bedarfen des anfragenden Onlinedienstes passt. Dazu können die Werte der folgenden Elemente geprüft werden:

• content[]:ars Es ist dasjenige content-Element zu wählen, dessen ars-Wert am genauesten mit dem gesuchten ARS übereinstimmt. Beispiel: eine Suche bezüglich Frankfurt/Main (ARS 064120000000) könnte zwei Leistungsbeschreibungen liefern, bei der die eine für ganz Hessen (ARS 060000000000) und die andere nur für Frankfurt/Main gilt. In diesem Fall ist die zweite Leistungsbeschreibung weiter zu verwenden.
  Hinweis: Es ist auch denkbar, den URL-Parameter useArsHierarchy auf false zusetzen. Dann besteht aber das Risiko, dass eine Suche mit einem Gemeinde-genauen ARS gar keine Ergebnisse liefert, wenn es nur eine Leistungsbeschreibung auf Ebene des Kreis-ARS und eine Leistungsbeschreibung auf Ebene des Bundesland-ARS gibt.
• content[]:availableLanguages[] Es ist dasjenige content-Element zu wählen, dessen Menge von Sprach-Codes in availableLanguages[] einen Sprach-Code enthält, der mit der Sprachpräferenz des Antragstellers am besten übereinstimmt.
  Hinweis: Wenn diese Regel ausgewertet werden muss, um ein eindeutiges content-Element zu bestimmen, dann ist dies ein Zeichen für eine riskante Datengestaltung in den Redaktionsystemen (s.u.) und sollte als Warnung geloggt werden.

Die genannten Kriterien sind in dieser Reihenfolge anzuwenden, bis ein einziges content-Element identifiziert werden konnte. Die Response enthält dann in dem identifizierten content-Element ein Element id dessen Wert (z.B. L100001.LB.360900603) die ID der Leistungsbeschreibung ist.

warnung

Die Möglichkeiten zur Datengestaltung, die XZuFi hier bietet, bergen ein Risiko: So ist es möglich, zwei Leistungsbeschreibungen im PVOG anzulegen, bei denen die eine als sprachversionen (content[]:availableLanguages[]) nur de und die andere nur en enthält, beide aber für dieselbe Leika und in demselben Gebiet genutzt werden. In einem solchen Fall müssen Zustaendingkeiten sowohl für die Organisationseinheiten als auch die Onlinedienste für beide Leistungsbeschreibungen angelegt werden, damit nicht von der Sprachauswahl abhängt, ob Organisationseinheiten und/oder Onlinedienste gefunden werden! Deutlich weniger riskant ist eine Datengestaltung, bei der nur eine einzige Leistungsbeschreibung erstellt wird, deren sprachversionen sowohl de als auch en enthält.

Dieses Risiko betrifft die Nutzung der Redaktionssysteme, da eine bestimmte Art der Datengestaltung vermieden werden sollte. Onlinedienste könnten nur mit hohem Aufwand mit heuristischen Verfahren versuchen, dieses Risiko zu mitigieren. Dies wird nicht empfohlen.