[[xplanvalidator-api]]
=== XPlanValidatorAPI

Die REST-API des XPlanValidator ermöglicht es, die Funktionen des XPlanValidator über eine Web-API aufzurufen.
Die REST-API des XPlanValidator stellt folgende Ressourcen bereit:

[width="100%",cols="30%,20%,50%",options="header"]
|===
|Ressource |HTTP Methode |Beschreibung
|`/` |`GET` |Beschreibung der Schnittstelle als OpenAPI 3.0 Dokument
|`/info` |`GET` |Informationen zur Software und Konfiguration
|`/validate` |`POST` |Validieren eines XPlanGML-Dokuments oder XPlanArchivs
|`/status/{uuid}` |`GET` |Abruf des Fortschritts für eine Validierungsanfrage
|`/report/{uuid}` |`GET` |Abruf eines Validierungsberichts
|`/report/{uuid}/geomfindings` |`GET` |Abruf von geometrischen Fehlern zu einem Validierungsbericht im Format GeoJSON
|===

Eine vollständige Beschreibung der HTTP Status-Codes und der unterstützten Formate (Encodings) für die jeweiligen Ressourcen sind in der OpenAPI-Schnittstellenbeschreibung enthalten.

NOTE: Die URL für die REST-API des XPlanValidator setzt sich wie folgt zusammen http://<host>:<port>/xplan-validator-api/api/v2/. Die URL für die xPlanBox-Demo lautet z. B. https://xplanbox.lat-lon.de/xplan-validator-api/api/v2/.

IMPORTANT: Die REST-API v1 ist veraltet und wird in zukünftigen Versionen der xPlanBox entfernt! Stellen Sie Clients auf die neue REST-API v2 um!