Menü der Dokumentation

Webservice-Funktionen

d.3 webservice Funktionen

Anmerkung

Sofern nicht anders angegeben, geben alle Funktionen bei Erfolg den String OK zurück, ansonsten eine Fehlermeldung.

Initialisierung

d3ws_startSession()

Initialisierung, gibt eine Session-ID zurück (z.Zt. ohne Verwendung)

d3ws_stopSession()

Finalisierung (optional, entspricht neuer Initialisierung)

XML-Erzeugung (-> XML-Out-Buffer)

d3ws_xml_start()

Beginn eines neuen XML-Dokuments, Löschen des bisherigen Puffers

d3ws_xml_openNode(name)

öffnet einen neuen Knoten, der mit CloseNode wieder geschlossen werden muss (also "<name>")

d3ws_xml_addNode(name, value)

erzeugt einen kompletten Knoten (also "<name>value</name")

d3ws_xml_closeNode(name)

schließt einen Knoten, der mit OpenNode geöffnet wurde

(also "</name>")

d3ws_xml_stop()

beendet das XML-Dokument, das jetzt gespeichert oder versendet werden kann

Laden, Speichern, Aufruf Web-Service

d3ws_xml_saveToFile (filename)

speichert den XML-Out-Buffer in die angegebene Datei

d3ws_xml_loadFromFile (filename)

lädt die angegebene Datei in den XML-In-Buffer

d3ws_http_addParameter (name, value)

fügt einen Parameter hinzu, der beim späteren Aufruf von

sendRequest als POST-Parameter mitgegeben wird

d3ws_http_setTraceFile (filename)

protokolliert nachfolgenden Aufruf von sendRequest in einer Datei (zur Fehlersuche geeignet)

d3ws_http_sendRequest (url)

Sendet den XML-Out-Buffer an die angegebene URL und lädt das Ergebnis des Requests in den XML-In-Buffer.

In der URL können GET-Parameter verwendet werden.

Wenn zuvor KEIN weiterer Parameter mitgegeben wurde

(addParameter), wird das XML per POST namenlos mitgesendet.

Andernfalls wird das XML per POST als Parameter "xml=" mitgesendet.

XML-Parser (-> XML-In-Buffer)

Navigation

d3ws_xml_setRootNode()

setzt den Fokus auf den Root-Node des XML-Dokuments

d3ws_xml_setParentNode()

setzt den Fokus auf den Parent-Node des bisher fokussierten Nodes

d3ws_xml_setNode (expression)

Setzt den Fokus auf einen beliebigen Node (relativ zum aktuell fokussierten Node)

expression kann sein:

  • "/" für den Root-Node

  • ".." für den Parent-Node

  • "1" – "n" für den n'ten Child-Node

(ggf, vorher mit countNodes durchzählen)

  • "name" für einen bestimmten Child-Node

eine beliebige Kombination der obigen Angaben (als Pfadangabe, getrennt mit "/")

d3ws_xml_setNodeByIndex (i)

Analog zu setNode("i"), allerdings kann hier wirklich ein Integer übergeben werden (setNode erwartet einen String)

Analyse

d3ws_xml_countNodes()

liefert die Anzahl der verfügbaren Child-Nodes unterhalb des gerade fokussierten Nodes

d3ws_xml_getNodeName (i)

liefert den Namen des i'ten Nodes

Zugriff auf enthaltene Werte

d3ws_xml_getNodeValue (expression)

liefert den Inhalt des mit expression bezeichneten Nodes (relativ zum aktuell fokussierten Node);

Verwendung von expression wie in setNode