-
latlon team authored- XPLANBOX-3240 set REST API v1 to deprecated, added v2 as default (c791c82e4) - XPLANBOX-3305 added known bug to user manual (3fad3b1e7) Co-authored-by:
Torsten Friebe <friebe@lat-lon.de>
Dropped from commit: a361ba7b51cadc3c4e982198db25ec3917d81146latlon team authored- XPLANBOX-3240 set REST API v1 to deprecated, added v2 as default (c791c82e4) - XPLANBOX-3305 added known bug to user manual (3fad3b1e7) Co-authored-by:Torsten Friebe <friebe@lat-lon.de>
Dropped from commit: a361ba7b51cadc3c4e982198db25ec3917d81146
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:
| Ressource | HTTP Methode | Beschreibung |
|---|---|---|
|
|
Beschreibung der Schnittstelle als OpenAPI 3.0 Dokument |
|
|
Informationen zur Software und Konfiguration |
|
|
Validieren eines XPlanGML-Dokuments oder XPlanArchivs |
|
|
Abruf des Fortschritts für eine Validierungsanfrage |
|
|
Abruf eines Validierungsberichts |
|
|
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.
| 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/. |
| 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! |