Benutzer-Werkzeuge

Webseiten-Werkzeuge


engine:procedures:im_traversetreeview_pu

Unterschiede

Hier werden die Unterschiede zwischen zwei Versionen angezeigt.

Link zu dieser Vergleichsansicht

engine:procedures:im_traversetreeview_pu [11.01.2016 ] (aktuell)
Zeile 1: Zeile 1:
 +===== im_TraverseTreeView_Pu =====
 +
 +Zu einem gegebenen Element des Artikelbaums wird das (nächste oder vorhergehende) benachbarte Element (auf Wunsch nur auf einer bestimmten Hierarchie) zurückgegeben.\\ ​
 +
 +Optional kann man auch nur einen Teilbaum "​traversieren"​.\\ ​
 +|HTTP-Method|POST |
 +|HTTP-Auth|Optional |
 +|Tags|{{tag>​[im Traverse Tree View Pu]}}|
 +|Engine-Kategorie|item management |
 +|Engine-Typ|Daten-Ermittlung |
 +|Letzte Aktualisierung|3.5.0 (2000-11-23)|
 +
 +==== Parameter ====
 +
 +^Name ((Pflichtparameter sind unterstrichen)) ^Standard-Wert ^Beschreibung ((siehe [[webservice:​engine_parameterconventions|Parameter-Konventionen engine/<​Prozedur-Name>​]])) ^SQL-Datentyp((siehe [[:​webservice:​engine_datatypes|Datentypen im Bereich "​engine"​]])) ^ab Version ^
 +|__TreeNodeID__| |ID eines Elementes im Artikelbaum,​ zu dem das (vorhergehende bzw. nächste) Nachbar-Element ermittelt werden soll\\ |integer|3.5.0|
 +|Next|1 |"​0"​ : Das vorhergehende Nachbar-Element suchen\\ "​1"​ : Das nächste benachbarte Element ermitteln\\ |bit|3.5.0|
 +|LevelNo|NULL |Nummer einer Hierarchie, auf der das Nachbar-Element liegen muß\\ |tinyint|3.5.0|
 +|DomainTreeNodeID|0 |ID eines Elementes im Artikelbaum. Es wird dann nur der Teilbaum "​traversiert",​ der dieses Element als Wurzel hat.\\ |integer|3.5.0|
 +==== Rückgabe ====
 +
 +=== (parameterunabhängig) ===
 +
 +^Spaltenname ​ ^Beschreibung ^SQL-Datentyp((siehe [[:​webservice:​engine_datatypes|Datentypen im Bereich "​engine"​]])) ^ab Version ^
 +|ResultTreeNodeID|ID des benachbarten Elementes von "​TreeNodeID"​. "​-1",​ falls keines gefunden wurde.\\ |integer|3.5.0 |
 +==== Output-Parameter ====
 +
 +Die Prozedur hat keine Output-Parameter.==== Mögliche Return-Codes ====
 +
 +^Code ^Beschreibung ^Quelle ((direkt meint "von der Prozedur selber"​ und indirekt meint "von intern aufgerufenen Unterprozeduren"​)) ^
 +|-510|Der Benutzer ist nicht registriert|nur indirekt|
 +|-500|Falsche Parameter|nur indirekt|
 +|-120|Der Benutzer hat keine Berechtigung für das (die) Element(e)|nur indirekt|
 +==== XML-Schema ====
 +
 +Die Rückgabe erfolgt als XML-Dokument welches gegen das Schema [[http://​resources.dstore.de/​xsd/​webservice_SmartGate/​Response/​EngineProcedure_v1_0.xsd|Response/​EngineProcedure_v1_0.xsd]] validiert.
 +==== Historie ====
 +
 +|3.5.0 |2000-11-23|Erstmalig in dieser Version erstellt\\ ​ |
 +
 +==== Code-Snippets ====
 +
 +== Engine Playground ==
 +Der folgende Link öffnet in einem separaten Fenster den Engine Playground der fest mit dem dbap-demo System verbunden ist:
 +  * [[http://​playground.dstore.de/​index.php?​proc=im_TraverseTreeView_Pu|im_TraverseTreeView_Pu im Engine Playground öffnen]]
 +== cURL ==
 +Unformatierte Ausgabe:
 +<code bash>
 +curl -X POST  '​http://<​partner>​-<​project>​.dstore.de/​default/​engine/​im_TraverseTreeView_Pu?​TreeNodeID=<​value>'</​code>​Mit xmllint ((I.d.R. auf Unix-artigen Systemen bereits installiert,​ Bestandteil der libxml2, siehe http://​www.xmlsoft.org)) formatierte Ausgabe:
 +<code bash>
 +curl -X POST  '​http://<​partner>​-<​project>​.dstore.de/​default/​engine/​im_TraverseTreeView_Pu?​TreeNodeID=<​value>'​ | xmllint --format -</​code>​== dStore_php ==
 +<code php>
 +use dStore_php\WebService;​
 +
 +$service = new WebService\Service( WebService\Scheme::​HTTP,'<​partner>​-<​project>​.dstore.de',​ 80);
 +
 +$request = new WebService\Requests\Engine\Procedure\Request(
 + new WebService\Requests\AccessData('​default'​),​
 + '​im_TraverseTreeView_Pu',​
 + array(
 + '​TreeNodeID'​ => <​value>,​
 + // '​Next'​ => 1,
 + // '​LevelNo'​ => NULL,
 + // '​DomainTreeNodeID'​ => 0
 + )
 +);
 +
 +$service->​execute($request);​
 +
 + $xml_result = $request->​getResponse()->​getBody()->​toSimpleXmlDocument();​
 + $ResultSet = $xml_result->​getRowsAsArray();​
 +
 +</​code>​
 +== engine/​execute ==
 +XML zur Ausführung mit der Methode [[:​webservice:​engine:​execute|engine/​execute]],​ z.B. per
 +  curl --header '​Content-Type:​ application/​xml'​ -X POST '​http://<​partner>​-<​kunde>​.dstore.de/​default/​engine/​execute'​ -d '<​xml-daten>'​
 +
 +<code xml>
 +<?xml version="​1.0"​ encoding="​UTF-8"?>​
 +<​ListOfBatches>​
 + <Batch No="​0">​
 + <​Procedure Name="​im_TraverseTreeView_Pu">​
 + <​Parameters>​
 + <​Parameter Name="​TreeNodeID"><​!-- integer value --></​Parameter>​
 + <!-- <​Parameter Name="​Next">​1</​Parameter>​ -->
 + <!-- <​Parameter Name="​LevelNo">​NULL</​Parameter>​ -->
 + <!-- <​Parameter Name="​DomainTreeNodeID">​0</​Parameter>​ -->
 + </​Parameters>​
 + </​Procedure>​
 + </​Batch>​
 +</​ListOfBatches></​code>​
  
engine/procedures/im_traversetreeview_pu.txt · Zuletzt geändert: 11.01.2016 (Externe Bearbeitung)