2 Posts getaggt mit "Suchdienst API"

Mit dem PVOG Release 9.15. wurde für den Suchdienst der neue Endpunkt /v1beta2/onlineservices veröffentlicht.

Der Endpunkt liefert Onlinedienste innerhalb des angefragten ARS-Bereichs. Die Filterung erfolgt entlang der ARS-Hierarchie sowohl nach oben als auch nach unten.

Filterung nach oben: Bei der Suche nach der ARS 091 (Oberbayern) werden Onlinedienste mit Zuständigkeit für 091 sowie für übergeordnete Ebenen geliefert, z.B. Bayern (09) oder Bund (00).

Filterung nach unten: Bei der Suche nach 091 werden zusätzlich Onlinedienste für untergeordnete Ebenen bis hinunter zur Gemeindeebene geliefert, z.B. München (091620000000).

Beispiele zu den Ergebnissen der Abfrage

1. Abfrage mit <= 1000 Ergebnisse Beispiel: https://stage.pvog.fitko.net/suchdienst/api/v1beta2/onlineservices?ars=100

Für die ARS 100 werden im ersten Schritt alle Ergebnisse der Abfrage (725 hits) der insgesamt 725 Ergebnisse (totalHits) angezeigt.

2. Abfrage mit > 1000 Ergebnissen Beispiel: https://stage.pvog.fitko.net/suchdienst/api/v1beta2/onlineservices?ars=090

Für die ARS 090 werden im ersten Schritt der Abfrage 1000 Ergebnisse (hits) der insgesamt 1590 Ergebnisse (totalHits) angezeigt.

Die weiteren Onlinedienste können durch das Setzen des „nextPageToken“ abgefragt werden.

Beispiel:

https://stage.pvog.fitko.net/suchdienst/api/v1beta2/onlineservices?ars=090&nextPageToken=L100042.OD.12184_43865

Einschränkung über Leika

Als weiterer Parameter kann in der Abfrage die Ergebnismenge auf eine Leistung aus dem Leistungskatalog eingeschränkt werden. Das Ergebnis sind die Onlinedienste, die für eine Leistung mit dem konkreten Leistungsschlüssel, zuständig sind.

https://stage.pvog.fitko.net/suchdienst/api/v1beta2/onlineservices?ars=090&leikaIds=99050012104000

Response

Antwortschema

Das Schema der Antwort ist auf dem Produktportal abgebildet und ermöglich die gezielte Weiterverarbeitung der Ergebnisse.

Parallel zum Produktportal kann auch die Swagger Dokumentation zum Ausprobieren verwendet werden.

Geben Sie gern Feedback zur vorgestellten beta API, z. b. in der User Group oder über das Helpdesk-Formular auf dem PVOG Produktportal!

Mit dem PVOG Release 9.15. wurde für den Suchdienst der neue Endpunkt /v1beta1/onlineservices veröffentlicht.

Der Endpunkt gibt die Organisationseinheiten zurück, die einem Onlinedienst zugeordnet sind. Der Test des Endpunktes kann über das Produktportal oder die Swagger Dokumentation erfolgen.

Beispiel: https://stage.pvog.fitko.net/suchdienst/api/v1beta1/onlineservices/L100012.OD.277549726/organisations

Ergebnis: Es werden alle zugeordneten Organisationseinheiten und die zugehörige Leistung ausgegeben.

Schema der Antwort

Die Beschreibungen der Rollen der Organisationseinheiten für den Onlinedienst sind an zwei Codelisten angelehnt:

• urn:xoev-de:fim:codeliste:xzufi.organisationseinheitsrollefueronlinedienst (ZSOD OE referenziert in 2.3.1)
• urn:xoev-de:fim:codeliste:xzufi.zustaendigkeitsrolle (XZuFi 2.2)

Bitte geben Sie gern Feedback zum neu veröffentlichten Endpunkt, z.B. in der User Group oder über das Helpdesk-Formular auf dem PVOG Produktportal!