Benutzer-Werkzeuge

Webseiten-Werkzeuge


engine:procedures:im_gettreenodeinformation_ad

Unterschiede

Hier werden die Unterschiede zwischen zwei Versionen angezeigt.

Link zu dieser Vergleichsansicht

engine:procedures:im_gettreenodeinformation_ad [11.01.2016 ] (aktuell)
Zeile 1: Zeile 1:
 +===== im_GetTreeNodeInformation_Ad =====
 +
 +Gibt diverse Informationen zu einem Element des Artikelbaums aus.\\ ​
 +
 +Hinweis :\\ Gibt es das Element "​TreeNodeID"​ nicht, wird eine leere Ergebnismenge zurückgegeben und nicht etwa "​-500"​ !\\ Entsprechend gibt es auch im Fall "​TreeNodeID = NULL" KEINEN Fehler - ein nicht vorhandenes Element in "​tempdb.dbo.OneID"​ taucht dann eben auch nicht in der Ergebnismenge auf !\\ 
 +|HTTP-Method|GET |
 +|HTTP-Auth|Optional |
 +|Tags|{{tag>​[im Get Tree Node Information Ad]}}|
 +|Engine-Kategorie|item management |
 +|Engine-Typ|Daten-Ermittlung |
 +|Letzte Aktualisierung|7.0.7 (2015-01-29)|
 +
 +==== 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 die Informationen ausgegeben werden sollen. Ist "​NULL"​ angegeben, erwarten wir in "​tempdb.dbo.OneID"​ eine Menge von "​TreeNodeID"​s.\\ |integer|3.5.0|
 +|LanguageID|0 |ID einer Sprache, in der die Bezeichnungen des zur "​TreeNodeID"​ zugehörigen Artikel-Elementes ausgegeben werden soll; bei "​LanguageID = 0" wird die "​DefaultLanguageID"​ aus "​Settings"​ genommen.\\ |tinyint|3.5.0|
 +|GetAdditionalInformation|1 |Steuert, ob zusätzliche Rückgabespalten geliefert werden sollen ("​1"​) oder nicht ("​0"​)\\ |bit|5.1.10|
 +==== Rückgabe ====
 +
 +=== wenn GetAdditionalInformation = 1 ===
 +
 +^Spaltenname ​ ^Beschreibung ^SQL-Datentyp((siehe [[:​webservice:​engine_datatypes|Datentypen im Bereich "​engine"​]])) ^ab Version ^
 +|NodeID|ID des zur "​TreeNodeID"​ zugehörigen Artikel-Elementes\\ |integer|3.5.0 |
 +|TreeNodeID|Nochmal die übergebene "​TreeNodeID"​ (Richtig, diese Spalte ist eigentlich überflüssig)\\ |integer|3.5.0 |
 +|Predecessor|ID des Vorgängers von "​TreeNodeID"​\\ |integer|5.1.10 |
 +|InheritsFrom|ID eines Elementes im Artikelbaum,​ VON dem "​TreeNodeID"​ Eigenschaften erbt\\ |integer|3.5.0 |
 +|NodeDescription|Bezeichnung der "​NodeID"​\\ |varchar(100)|3.5.0 |
 +|Active|Ist "​TreeNodeID"​ z.Zt. aktiviert ? ("​0"​ : Nein, "​1"​ : Ja)\\ |bit|3.5.0 |
 +|CountSuccessors|Wieviele Nachfolger (egal ob aktiv oder nicht, egal ob gelöscht oder nicht) hat "​TreeNodeID"​\\ |integer|3.5.0 |
 +|SymbolID|ID eines Symbols, das der "​NodeID"​ zugeordnet ist\\ |smallint|3.5.0 |
 +|LevelNo|Nummer der Hierarchie der "​NodeID"​\\ |tinyint|3.5.0 |
 +|SortNo|Bestimmt die Reihenfolge von "​TreeNodeID"​ innerhalb aller "​Nachbar"​-Elemente von "​TreeNodeID"​ ("​Nachbar"​-Elemente haben den gleichen Vorgänger)\\ |smallint|3.5.0 |
 +|Deleted|Ist "​TreeNodeID"​ bereits gelöscht ? ("​0"​ : Nein, "​1"​ : Ja)\\ |bit|4.0.15 |
 +|LevelID|ID der Hierarchie der "​NodeID"​\\ |tinyint|5.0.4 |
 +|CountActiveSuccessors|Anzahl aktiver ("​Active = 1") und nicht gelöschter ("​Deleted = 0") Nachfolge-Elemente von "​TreeNodeID"​\\ |integer|5.0.4 |
 +|CountDeletedSuccessors|Anzahl gelöschter ("​Deleted = 1") Nachfolge-Elemente von "​TreeNodeID"​\\ |integer|5.0.4 |
 +=== wenn GetAdditionalInformation = 0 ===
 +
 +^Spaltenname ​ ^Beschreibung ^SQL-Datentyp((siehe [[:​webservice:​engine_datatypes|Datentypen im Bereich "​engine"​]])) ^ab Version ^
 +|NodeID|ID des zur "​TreeNodeID"​ zugehörigen Artikel-Elementes\\ |integer|5.1.10 |
 +|TreeNodeID|Nochmal die übergebene "​TreeNodeID"​ (Richtig, diese Spalte ist eigentlich überflüssig)\\ |integer|5.1.10 |
 +|Predecessor|ID des Vorgängers von "​TreeNodeID"​\\ |integer|5.1.10 |
 +|InheritsFrom|ID eines Elementes im Artikelbaum,​ VON dem "​TreeNodeID"​ Eigenschaften erbt\\ |integer|5.1.10 |
 +|NodeDescription|Bezeichnung der "​NodeID"​\\ |varchar(100)|5.1.10 |
 +|Active|Ist "​TreeNodeID"​ z.Zt. aktiviert ? ("​0"​ : Nein, "​1"​ : Ja)\\ |bit|5.1.10 |
 +|CountSuccessors|Wieviele Nachfolger (egal ob aktiv oder nicht, egal ob gelöscht oder nicht) hat "​TreeNodeID"​\\ |integer|5.1.10 |
 +|SymbolID|ID eines Symbols, das der "​NodeID"​ zugeordnet ist\\ |smallint|5.1.10 |
 +|LevelNo|Nummer der Hierarchie der "​NodeID"​\\ |tinyint|5.1.10 |
 +|SortNo|Bestimmt die Reihenfolge von "​TreeNodeID"​ innerhalb aller "​Nachbar"​-Elemente von "​TreeNodeID"​ ("​Nachbar"​-Elemente haben den gleichen Vorgänger)\\ |smallint|5.1.10 |
 +|Deleted|Ist "​TreeNodeID"​ bereits gelöscht ? ("​0"​ : Nein, "​1"​ : Ja)\\ |bit|5.1.10 |
 +|LevelID|ID der Hierarchie der "​NodeID"​\\ |tinyint|5.1.10 |
 +==== 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"​)) ^
 +|-621|Fehlender oder falscher Eintrag in PersonTypeSettings|nur indirekt|
 +|-569|Der Benutzer hat kein Ausführungsrecht für die Prozedur|nur indirekt|
 +|-567|Die Prozedur darf z. Zt. nicht ausgeführt werden|nur indirekt|
 +|-566|Die Prozedur darf mit den übergebenen Parametern nicht ausgeführt werden|nur indirekt|
 +|-550|Fehlender oder falscher Eintrag in Settings|nur indirekt|
 +|-535|Das Datum liegt nicht in der Vergangenheit|nur indirekt|
 +|-530|Der Wert ist nicht konvertierbar|nur indirekt|
 +|-510|Der Benutzer ist nicht registriert|nur indirekt|
 +|-504|Es ist ein Problem aufgetreten,​ das nicht gelöst werden kann, Prozedur wird daher abgebrochen|direkt und 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 ====
 +
 +|7.0.7 |2015-01-29|Interne Änderung : Datentyp-Erweiterung des "​ReferenceKey"​ [für "​_mi_StartProcedure"​-Aufruf]\\ ​ |
 +|6.5.2 |2013-02-26|Fehler : Bei der Überprüfung,​ ob eine "​varchar"​-Variable "​voll"​ ist, muß die Funktion "​datalength"​ [nicht\\ "​char_length"​] verwendet werden\\ ​ |
 +|5.5.1 |2008-07-29|1. Berücksichtigung des neuen "​Settings"​-Eintrags "​AssignmentMethodForListVariables"​\\ 2. Änderung der Ermittlung falls "​TreeNodeID"​ angegeben ist, damit die "​Count..."​-Rückgabespalten auch für ASE 15.0.2 korrekt sind\\ ​ |
 +|5.1.10 |2007-03-12|1. Neuer Parameter "​GetAdditionalInformation"​\\ 2. Neue Möglichkeit,​ MEHRERE IDs [via "​OneID"​] übergeben zu können\\ 3. Neue Rückgabespalte "​Predecessor"​\\ ​ |
 +|5.1.0 |2006-02-08|Rückgabespalte "​SortNo"​ war fälschlicherweise in 5.0.4 ein "​integer"​ - jetzt ist es wieder ein "​smallint"​\\ ​ |
 +|5.0.4 |2005-09-26|Neue Rückgabespaltem "​LevelID",​ "​CountActiveSuccessors"​ und "​CountDeletedSuccessors"​\\ ​ |
 +|4.0.15 |2004-07-30|Neue Rückgabespalte "​Deleted"​\\ ​ |
 +|4.0.11 |2004-03-31|1. Aufruf der Prozeduren "​_mi_StartProcedure"​ und "​_mi_FinishProcedure"​\\ ​                                    2. Ausführen von "set transaction isolation level 1" und "set rowcount 0" zu Beginn der Prozedur\\ ​ |
 +|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_GetTreeNodeInformation_Ad|im_GetTreeNodeInformation_Ad im Engine Playground öffnen]]
 +== cURL ==
 +Unformatierte Ausgabe:
 +<code bash>
 +curl -X GET  '​http://<​partner>​-<​project>​.dstore.de/​default/​engine/​im_GetTreeNodeInformation_Ad?​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 GET  '​http://<​partner>​-<​project>​.dstore.de/​default/​engine/​im_GetTreeNodeInformation_Ad?​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_GetTreeNodeInformation_Ad',​
 + array(
 + '​TreeNodeID'​ => <​value>,​
 + // '​LanguageID'​ => 0,
 + // '​GetAdditionalInformation'​ => 1
 + )
 +);
 +
 +$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_GetTreeNodeInformation_Ad">​
 + <​Parameters>​
 + <​Parameter Name="​TreeNodeID"><​!-- integer value --></​Parameter>​
 + <!-- <​Parameter Name="​LanguageID">​0</​Parameter>​ -->
 + <!-- <​Parameter Name="​GetAdditionalInformation">​1</​Parameter>​ -->
 + </​Parameters>​
 + </​Procedure>​
 + </​Batch>​
 +</​ListOfBatches></​code>​
  
engine/procedures/im_gettreenodeinformation_ad.txt · Zuletzt geändert: 11.01.2016 (Externe Bearbeitung)