Skip to content

Nutzung der neuen JZuFi-Endpunkte

User Story

Nachdem der Test derneuen Endpunkte in #3294 (closed) ergeben hat, dass diese genutzt werden können, soll der Routingdienst diese verwenden:

  • /v3/servicedescriptions/jzufi
  • /v3/relations/{ars}/jzufi
  • /v2/organisationunits/jzufi

Bei den neuen Endpunkten muss die XZuFi-Version angegeben werden. Mit XZuFi 2.3.1 kann die DestinationSignature auch an anderen Stellen als unter idSekundaer der Zuständigkeit der Organisationseinheit gepflegt werden (siehe unten). Daher erfolgt die Abfrage mit XZuFi 2.3.1. Ein Zustellpunkt wird gefunden, wenn die DestinationID entweder wie bisher in idSekundaer enthalten ist, oder wenn sie unter dem Kommunikationssystem in der Zuständigkeit einer Organisationseinheit angegeben wurde.

Warum

Die Endpunkte wurden abgekündigt.

Links, Hinweise, Bemerkungen

Zusätzlicher Ort für die DestinationSignature bei XZuFi 2.3.1

Quelle: https://docs.fitko.de/efa-parametrisierung/docs/parameter_katalog/zustellungskanal_destinationsignature#ermittlungsm%C3%B6glichkeit-pvog-api

In XZuFi 2.3.1 wird das Element Kommunikationssystem nicht mehr direkt der Organisationseinheit, sondern deren Zustaendigkeit für eine Leistung und eine gebietID (i.e. ARS) zugeordnet sein. Es soll hier daher für XZuFi 2.3.1 festgelegt werden, dass die Adressinformationen für FIT-Connect dann in einem Kommunikationssystem-Element hinterlegt werden. Dieses soll dann dadurch identifiziert werden, dass es im Element kommunikationssystem[].kanal.code den Wert "004" ("System mit Anbindung an FIT-Connect") der Code-Liste urn:xoev-de:fim:codeliste:xzufi.kommunikationssystemtyp trägt.

In dem so identifizierten Kommunikationssystem-Element werden dann die beiden Elemente kennung und kennungZusatz die Adressinformationen tragen:

kennung= <DestinationSignature>
kennungZusatz = <DestinationID aus der DestinationSignature> (optional)

Die DestinationID ist eigentlich redundant, da sie auch in der DestinationSignature encodiert ist. Ist das kennungZusatz-Element gefüllt, kann der Onlinedienst diese Information direkt weiter verwenden und braucht die DestinationSignature nicht selbst zu decodieren.

Bsp:

<xzufi:zustaendigkeit>
<xzufi:id schemeAgencyID="L100012" schemeID="ZustaendigkeitOrganisationseinheit">292101506.280702831.010000000000</xzufi:id>
<xzufi:idSekundaer schemeAgencyID="urn:de:fitko" schemeID="urn:de:fitko:fit-connect:xzufi:destination"><!-- verkürzte Darstellung des DestinationSignature JSON Web Token (JWT) --> </xzufi:idSekundaer>
<xzufi:leistungID schemeAgencyID="L100012" schemeAgencyName="TSA Public Service GmbH" schemeID="TSA_ZUFISH_OID" schemeName="Zuständigkeitsfinder Schleswig-Holstein ObjektID">292101506</xzufi:leistungID>
<xzufi:gebietID schemeID="urn:de:bund:destatis:bevoelkerungsstatistik:schluessel:bundesland" schemeVersionID="2010-04-01">010000000000</xzufi:gebietID>
<xzufi:kommunikationssystem>
<xzufi:kanal listURI="urn:xoev-de:fim:codeliste:xzufi.kommunikationssystemtyp" listVersionID="1">
<code>004</code>
</xzufi:kanal>
<xzufi:kennung><!-- verkürzte Darstellung des DestinationSignature JSON Web Token (JWT) --></xzufi:kennung>
<xzufi:kennzeichenOeffentlichAnzeigen>true</xzufi:kennzeichenOeffentlichAnzeigen>
</xzufi:kommunikationssystem>
<xzufi:rolle listURI="urn:xoev-de:fim:codeliste:xzufi.zustaendigkeitsrolle" listVersionID="1">
<code>02</code>
</xzufi:rolle>
<xzufi:rolle listURI="urn:xoev-de:fim:codeliste:xzufi.zustaendigkeitsrolle" listVersionID="1">
<code>03</code>
</xzufi:rolle>
</xzufi:zustaendigkeit>

Akzeptanzkriterien

  1. Der Routingdienst (Routing API v1 und v2) verwendet die drei neuen Endpunkt-Versionen unter Angabe der XZuFi-Version 2.3.1.
  2. Ein Zustellpunkt wird gefunden, wenn sich eine gültige DestinationSignature wie bisher in idSekundaer der Zuständigkeit der Organisationseinheit befindet.
  3. Ein Zustellpunkt wird gefunden, wenn sich in der Zuständigkeit einer Organisationseinheit eine gültige DestinationSignature unter kennung in einem kommunikationssystem mit kanal "urn:xoev-de:fim:codeliste:xzufi.kommunikationssystemtyp" vom Code 004 befindet (vgl. "Zusätzlicher Ort für die DestinationSignature bei XZuFi 2.3.1" unter "Links, Hinweise, Bemerkungen").
  4. Sollte ein Zustellpunkt über beide Varianten gefunden werden, wird er nur einmal ausgegeben.
  5. Die Prüfung der Gültigkeit einer DestinationSignature erfolgt wie bisher, egal, wo sie gefunden wurde.
  6. Die Daten zu Organisationseinheit, EfA-Parametern und CustomParametern werden wie bisher ausgegeben, unabhängig davon, wo die DestinationSignature gefunden wurde.

Mögliche Folgeaktivitäten (vom Entwickler zu ergänzen)

Edited by Andreas Aschauer