diff --git a/README.md b/README.md index c0735b78ae72aa5835f72422dfd399f739bf0cc3..e2386bd9d51d2fe976feee3ee7524971177464f8 100644 --- a/README.md +++ b/README.md @@ -18,11 +18,13 @@ * Teil der PVOG-Daten * wird durch eine OID identifiziert * OID - * kurz für OrganisationsEinheitenIDs + * kurz für OrganisationsEinheitID * identifiziert eine OrganisationsEinheit + * wird von einem Herausgeber erstellt, der hier aber nicht genannt ist * XZufi-OID - * Enthält den numerischen Identifier der Behörde selbst und den numerischen Identifier des Herausgebers (z.B. des Landes Schleswig-Holstein) - * ist nur in dieser Kombination eindeutig + * Enthält den numerischen Identifier der Behörde und den numerischen Identifier des Herausgebers (z.B. TSA Public Service GmbH für das Land Schleswig-Holstein) + * ist nur in der Kombination eindeutig + * Die Unterscheidung ist erforderlich, da es Zufi-Deployments geben könnte, die neben Behörden eines Bundeslandes andere Behörden (z.B. Bundesebene) mit einem anderen Herausgeber enthalten. Nur über die OID kann eine Behörde nicht exakt bestimmt werden. * Fachstelle * Bezeichnung für eine Einheit, die fachliche Aufgaben übernimmt, aber beliebiger Natur sein kann * Beispiele: Vereine, Schulen, Firmen, ... @@ -56,7 +58,8 @@ * vorgang-manager einer Kommune verarbeiten konkrete XZufi-OIDs * Beim Start dieser Anwendung kann eine Registrierung am Zufi erfolgen * Abruf vorgang-manager - * Sofern ein vorgang-manager registriert ist, kann dessen Adresse unter Angabe einer XZufi-OID erfragt werden + * Sofern ein vorgang-manager registriert ist, kann dessen Adresse unter Angabe einer OID erfragt werden + * Hinweis: Die ausschließliche Verwendung der OID ist veraltet. Es wird empfohlen, die XZufi-OID zu verwenden. * Registrierung Fachstelle * betrifft externe Fachstellen (also keine Behörden/Organisationseinheiten aus den PVOG-Daten) * Fachstellen können sich in der OZGCloud registrieren, die Daten werden hier gespeichert @@ -89,7 +92,7 @@ This properties must be configured to run the application: | ozgcloud.pvog.oauth2.client-id | ozgcloud | none | yes | Id of the PVOG SSO client | | ozgcloud.pvog.oauth2.client-secret | secret | none | yes | The secret of the PVOG SSO client | | ozgcloud.pvog.url | https://pvog.service | none | yes | The address of the PVOG service | -| ozgcloud.pvog.endpoints.verwaltungsobjekte.path | /v1/verwaltungsobjekte | none | yes | Path of the endpoint that delivers Verwaltungsdaten | +| ozgcloud.pvog.endpoints.verwaltungsobjekte.path | /v2/verwaltungsobjekte | none | yes | Path of the endpoint that delivers Verwaltungsdaten | | ozgcloud.zufi.land.amtliche-regional-schluessel | 01% | none | no | The ARS code used for requests | # Architekturgrafik