1.4.2
🛠️ API Services
HTTP Dienste
xplanung_docs

xplanung_docs

Der Dienst xplanung_docs liefert alle Dateiverweise aus einer XPlanung-GML-Datei zurück. Dabei werden alle Knoten vom Typ XP_ExterneReferenz und XP_SpezExterneReferenz durchlaufen und Title und URL ausgegeben.

  • dieser Dienst ist bei der ausführenden Funktion des Popup Inhalts getXPlanungAttachments eingebunden
  • ein eindeutiger Schlüssel key wird pro XPlanung vorausgesetzt. Die GML-Dateien müssen über die URL-Struktur {baseURL}/{key}/{key}.gml verfügbar sein. Als key eignen sich beispielsweise die Attribute nummer, GML_ID oder internalId aus dem XPlanung Standard.

Beispiel URL: https://mydomain.de/bplan_files/08-253-006/08-253-006.gml

Beispielkonfiguration

{
	"baseUrl": "https://mydomain.de/bplan_files",
	"namespaces": {
		"": "http://www.xplanung.de/xplangml/5/0"
	},
	"relativePaths": true
}

Parameter

EigenschaftTypBeschreibung
baseUrlURLBasis-Url, unter der die XPlanung-GML Dateien zur Verfügung stehen
namespacesObjectSchlüsselwertpaare mit Namensräume, die für das Lesen der Knoten im GML-File erforderlich sind
relativePathsBooleanGibt an, ob die Dateireferenzen relativ zur GML-Datei angegebene sind (true) oder ob es sich um vollständige URLs handelt (false)