Versionierung
Die Schnittstelle ist versioniert, was an der Komponente /{version}/ (bspw. /v1/) in der URL erkennbar ist. Wenn Änderungen an der Schnittstelle vorgenommen werden, wird eine neue Schnittstellen-Version mit einer inkrementierten Versionierungskomponente bereitgestellt. Alle Konsumenten werden informiert und die bisherige Schnittstellen-Version wird abgekündigt, bleibt aber für mindestens weitere 6 Monate verfügbar, um einen reibungslosen Wechsel zu ermöglichen. Zum 01.05. und 01.11. jeden Jahres werden Schnittstellen-Versionen, die mehr als 6 Monate abgekündigt sind, endgültig entfernt (siehe dazu auch das PVOG Releasekonzept).
Die aktuell gültige Version der Schnittstelle ist /v3/verwaltungsobjekte/xzufi-2-3-1.
Der größte Unterschied zur alten Version /v2/verwaltungsobjekte/ ist, neben der erweiterten URL, dass die XZuFi-Version der Antwort nicht mehr per Accept-Header gewählt werden kann, sondern jetzt auf die XZuFi-Version 2.3.1 festgeschrieben ist.
Gleichzeitig wurde die Schnittstelle /v2/verwaltungsobjekte/ funktional so verändert, dass auch dort die XZuFi-Version 2.2.0 nicht mehr unterstützt wird. Generell wurde damit die Abfrage der Daten im XZuFi-Format 2.2.0 unterbunden.
| Version | Datum | Status | Anmerkungen |
|---|---|---|---|
| v1 | April 2021 | entfernt | Abschaltung erfolgte im Januar 2023 |
| v2 | März 2022 | abgekündigt | Abkündigung erfolgte im Mai 2026 |
| v3 | Mai 2026 | aktiv | - |
Der Wechsel kann zu einem beliebigen Zeitpunkt im Übergangszeitraum durchgeführt werden. Gewisse Informationen können gegebenenfalls erst nach dem Wechsel auf die neuere Schnittstellenversion abgerufen werden.
Wenn ein Wechsel auf eine neuere Version durchgeführt wird, kann es notwendig sein, den lokalen Datenbestand zu löschen und eine neue Initialbefüllung durchzuführen. Beim Wechsel von v2 auf v3 ist dies nicht notwendig, aber ratsam, wenn die Daten bisher im Format XZuFi 2.2.0 abgerufen wurden.