XZuFiValidatorController
Die XZuFi Dokumente müssen wie in dem Sammlerdienstkonzept beschrieben an dem Bereitstellort zur Verfügung gestellt werden. Nach dem Start der Validierung ist über einen Fortschritt-Endpunkt in regelmäßigen Intervallen der Status der Validierung abzufragen. Wurde der Status FINISHED erreicht, so kann über den Report-Endpunkt ein Fehlerbericht als JSON oder Text angefordert werden. Der Report wird nach 30 Minuten nach Ende der Validierung automatisch gelöscht.
Der Validierungsprozess durchläuft vier Phasen, welche durch folgende Status repräsentiert werden:
- WAITING: Validierungsanfrage wurde entgegengenommen. Es wird gewartet bis genug Ressourcen frei sind
- READING_INDEX: Index Datei wird eingelesen
- VALIDATING: Die Validierung der XZuFi Dokumente läuft
- FINISHED: Die Validierung wurde beendet
Zusätzlich:
- STOPPED: Die Validierung wurde gestoppt. Ein Zugriff auf das Fortschrittsobjekt oder auf den Report ist nicht mehr möglich
Mit Hilfe der Yaml Version dieser Dokumentation kann ein REST Client generiert werden. Pfad zu der Yaml Version: /api/api-docs (siehe Eingabefeld oben)
📄️ Aufruf der Validierung.
Nimmt eine Validierungsanfrage entgegen. Initiiert einen Validierungsprozess und erzeugt die ID, über welche auf den asynchron ablaufenden Validierungsprozess zugegriffen werden kann. Legt die Validierung in eine Warteschlange. Sobald genügend Ressourcen zur Verfügung stehen, wird die Validierung gestartet.
📄️ Aufruf der benutzerdefinierten Validierung.
Nimmt eine Validierungsanfrage entgegen. Initiiert einen Validierungsprozess und erzeugt die ID, über welche auf den asynchron ablaufende Validierungsprozess zugegriffen werden kann. Legt die Validierung in eine Warteschlange. Sobald genug Ressourcen zur verfügung stehen, wird die Validierung gestartet.
📄️ Prüft eine URL auf Gültigkeit.
Hilfswerkzeug, um Syntax-Fehler in einer URL zu finden. Kann z.B. verwendet werden, um Fehlerprotokolle des URL-Validators nachzuvollziehen.
📄️ Liefert den Validatorreport.
Der Validatorreport kann erst angefordert werden, wenn der Status FINISHED erreicht ist, ansonsten wird HTTP Status 428 (Precondition Required) zurückgeliefert. Der Validatorreport wird ab einer bestimmten Größe gekürzt, der Vorgabewert für die maximale Berichtgröße ist 5MB. Um einen ungekürzten Fehlerbericht zu erhalten kann der Endpunkt /komplettreport verwendet werden.
📄️ Liefert den kompletten Validatorreport als JSON oder Text Datei.
Der Validatorreport kann erst angefordert werden, wenn der Status FINISHED erreicht ist, ansonsten wird HTTP Status 428 (Precondition Required) zurückgeliefert.
📄️ Informationen zu einem Land.
Gibt alle gespeicherten Informationen eines Landes nach angegebenem Redsyscode aus.
📄️ Liefert die Validierungsstatistik.
Die Statistik zur Validierung kann erst angefordert werden, wenn der Status FINISHED erreicht ist, ansonsten wird HTTP Status 428 (Precondition Required) zurückgeliefert.
📄️ getXZuFiProgressV1
Liefert den Fortschritt der Validierung.
📄️ Liefert die Fachvalidatorkonfiguration.
Die Fachvalidatorkonfiguration enthält eine Liste der unterstützten XZuFi-Versionen sowie eine Liste
📄️ Stoppt den Validierungsprozess
Stoppt den Validierungsprozess, kann in der Phase VALIDATING ausgeführt werden. Ein Zugriff auf das Fortschrittsobjekt oder auf den Report ist nicht mehr möglich.