XML

Aus CavoxCms Wiki

Das Resultat eines Command kann auch direkt als einfach zu verarbeitendes XML gelesen werden.

Inhaltsverzeichnis 1 Aufruf 1.1 Parameter 1.2 Methoden 2 Antwort 2.1 Aufbau des XML 3 Links

Aufruf

index.php?_output=xml&cmd=mymodule:mycontroller.mycommand&param1=value1&param2=value2 

Parameter

• _output:
  • xml: Antwort als XML ausgeben (ohne Session-ID)
  • xml:session_id: Wird meist beim Senden des Benutzernamens und Passwortes gesetzt und liefert dann zusätzlich die Session-ID. Sollte nur einmal verwendet werden pro Session da unsicher durch Versenden der Session-ID. Werden mehrere Befehle ausgeführt, ist diese Methode sicherer da nicht dauerhafte Daten gesendet werden im Gegensatz zum unverschlüsselten Versenden von Benutzernamen und Passwort.
  • json: Antwort in der JavaScript Object Notation ausgeben
• cmd: Aufgeteilt nach dem Schema: mymodule.mymodel.mycommand (Standardisierte Befehle: get, save, delete)
• un: Benutzername
• pw: Passwort

Methoden

Das XML kann per GET oder POST (HTTP) angefordert werden. Desweiteren können auch Dateien übermittelt werden: Diese werden dann auch per Schlüssel identifiziert. Die Daten werden dabei in UTF-8 übermittelt.

Antwort

http://www.cavoxcms.ch/?_output=xml&cmd=system:system.version

<?xml version="1.0" encoding="UTF-8"?>
<CavoxCms object="command_result">
	<hasErrors>1</hasErrors>
	<module>system</module>
	<component>main</component>
	<command>version</command>

	<errors></errors>
	<result>
		<version>2.0.2</version>
	</result>
	<output></output>

	<execution>18</execution>
	<language>de</language>
	<user></user>
</CavoxCms>

Aufbau des XML

• hasErrors: Anzahl Fehler in der errors-Struktur (unten). Verwendung in AJAX/JavaScript.
• module.component.command: Ausgeführter Befehl
• errors: Liste mit den aufgetretenen Fehler
• result: Resultat der Abfrage
• output: HTML-Ausgabe der Abfrage. Wird meist für AJAX-Abfragen verwendet
• execution: Dauer, die der Server für die Ausführung benötigte (in ms)
• language: Sprache der Abfrage
• user: Angemeldeter Benutzer

Links

Zugriff mit anderen Programmiersprachen:

• .NET
• Java