Eine offizielle Website der Bundesrepublik Deutschland
Zum Hauptinhalt springen

Suchen von Leistungen – Neuer Endpunkt im Suchdienst

2 Minuten Lesezeit

Mit dem PVOG Release 9.21. wurde ein neuer Endpunkt für den Suchdienst vorgestellt: suchdienst/api/v8beta1/servicedescriptions 

Dieser Endpunkt löst perspektivisch den Endpunkt /v7/servicedescriptions/{ars} ab.

Ähnlich wie /v7/servicedescriptions/{ars} sucht /v8beta1/servicedescription in einem ARS-Bereich nach Leistungen, in denen der Suchbegriff enthalten ist. Das Ergebnis ist eine Liste von Leistungen.

Im Vergleich der beiden Endpunkte wurde sowohl das Input Modell, als auch das Output Modell reduziert und die Paginierung neu aufbereitet.

In der Abfrage (Input) sind Default Werte für page und size gesetzt. Das Gültigkeitsdatum ist jetzt immer der Zeitpunkt der Abfrage; für die Ausgabe muss die Leistung gültig sein. Dynamische Parameter werden standardmäßig ausgegeben.

Im Ergebnis (Output) wurden Details zur Leistung entfernt und Zugangskanäle (XZuFi Schema 2.3.1) hinzugefügt.

Output Model v8beta1_servicedescriptions.png mit Zugangskanälen

Aktuell ist der Endpunkt bereits am SuchClient (servicesuche.bund.de) implementiert.

Hinweis: Diese API-Änderungen sind noch im Beta-Stadium, also noch nicht produktiv. Wir wollen frühzeitig über diese Änderungen informieren. Nutzen Sie gern die OpenAPI Dokumentation zum Testen ihrer UseCases.

Bitte geben Sie, als Konsumenten gern Feedback zur Weiterentwicklung!

Suchdienst Nutzer, die bereits eine Client ID nutzen, werden von uns mit der Bitte um Feedback direkt kontaktiert.