Unterschiede

Hier werden die Unterschiede zwischen zwei Versionen angezeigt.

@@ Zeile 1: / Zeile 1: @@
+===== im_GetNodeDescriptions_Pu =====
+Sucht zu Artikel-Elementen bzw. Elementen des Artikelbaums die Bezeichnung heraus, wobei das für Elemente der Produkt-Hierarchie auch die Eigenschaft zum Merkmal "Produktbezeichnung" sein kann (wenn "LookForProductDescriptions = 1" übergeben wurde).\\
+Hinweis : Falls der Aufrufer der "publicuser" ist, werden gelöschte und/oder deaktivierte Elemente IGNORIERT (es gibt aber auch keinen Fehler) !\\
+|HTTP-Method|GET |
+|HTTP-Auth|Optional |
+|Tags|{{tag>[im Get Node Descriptions Pu]}}|
+|Engine-Kategorie|item management |
+|Engine-Typ|Daten-Ermittlung |
+|Letzte Aktualisierung|7.0.1 (2013-08-07)|
+==== 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 ^
+|__NodeIDs__| |Liste, die IDs von Artikel-Elementen bzw. Elementen des Artikelbaums (durch '¶' getrennt) enthält, zu denen die Bezeichnungen ermittelt werden sollen. Falls "NULL" übergeben wird, erwartet die Prozedur die Elemente in "tempdb.dbo.OneID".\\ |varchar(255)|3.5.0|
+|IsTreeNodeID|0 |"0" : Bei den angegebenen IDs handelt es sich um Artikel-Elemente ("NodeID"s aus der Tabelle "dStore")\\ "1" : Die IDs sind Elemente des Artikelbaums ("TreeNodeID"s aus "TreeView")\\ |bit|3.5.0|
+|__LanguageID__| |ID einer Sprache, in der die Bezeichung der Artikelelemente ausgegeben werden soll\\ |smallint|3.5.0|
+|LookForProductDescriptions|1 |Artikel-Elemente der Produkt-Hierachie besitzen oftmals eine Eigenschaft zum Merkmal "Produktbezeichnung" (in einer Sprache). Soll (falls vorhanden) statt der "NodeDescription" die Eigenschaft zu diesem Merkmal  ausgegeben werden, übergibt man hier "1".\\ |bit|3.5.0|
+|StoreTreeNodeIDsInResult|0 |"1" angeben, um (nur im Fall "IsTreeNodeID = 1 !) in der Ergebnismenge statt der Spalte "NodeID" die Spalte "TreeNodeID" zu erhalten\\ |bit|4.0.5|
+==== Rückgabe ====
+=== wenn IsTreeNodeID = 0 ===
+^Spaltenname  ^Beschreibung ^SQL-Datentyp((siehe [[:webservice:engine_datatypes|Datentypen im Bereich "engine"]])) ^ab Version ^
+|NodeID|ID eines Artikel-Elementes, das in "NodeIDs" bzw. "tempdb.dbo.OneID" übergeben wurde\\ |integer|3.5.0 |
+|Description|Bezeichnung der "NodeID". Falls "LookForProductDescriptions = 1" übergeben wurde, steht hier auch evtl. die Eigenschaft zum Merkmal "Produktbezeichnung" (zur Sprache "LanguageID")\\ |varchar(1000)|3.5.0 |
+== Sortierung der Rückgabe ==
+(parameterunabängige Sortierung)
+  * NodeID (aufsteigend)
+=== wenn IsTreeNodeID = 1 und StoreTreeNodeIDsInResult = 0 ===
+^Spaltenname  ^Beschreibung ^SQL-Datentyp((siehe [[:webservice:engine_datatypes|Datentypen im Bereich "engine"]])) ^ab Version ^
+|NodeID|ID eines Artikel-Elementes, das zu einer der in "NodeIDs" bzw. "tempdb.dbo.OneID" angegebenen "TreeNodeID"s gehört\\ |integer|3.5.0 |
+|Description|Bezeichnung der "NodeID". Falls "LookForProductDescriptions = 1" übergeben wurde, steht hier auch evtl. die Eigenschaft zum Merkmal "Produktbezeichnung" (zur Sprache "LanguageID")\\ |varchar(1000)|3.5.0 |
+== Sortierung der Rückgabe ==
+(parameterunabängige Sortierung)
+  * NodeID (aufsteigend)
+=== wenn IsTreeNodeID = 1 und StoreTreeNodeIDsInResult = 1 ===
+^Spaltenname  ^Beschreibung ^SQL-Datentyp((siehe [[:webservice:engine_datatypes|Datentypen im Bereich "engine"]])) ^ab Version ^
+|TreeNodeID|ID eines Elementes des Artikelbaums, das in "NodeIDs" bzw. "tempdb.dbo.OneID" übergeben wurde\\ |integer|4.0.5 |
+|Description|Bezeichnung der zur "TreeNodeID" zugehörigen "NodeID". Falls "LookForProductDescriptions = 1" übergeben wurde, steht hier auch evtl. die Eigenschaft zum Merkmal "Produktbezeichnung" (zur Sprache "LanguageID")\\ |varchar(1000)|4.0.5 |
+== Sortierung der Rückgabe ==
+(parameterunabängige Sortierung)
+  * TreeNodeID (aufsteigend)
+==== 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|
+|-550|Fehlender oder falscher Eintrag in Settings|nur indirekt|
+|-500|Falsche Parameter|nur indirekt|
+|-286|Der Benutzer hat nicht die Berechtigung(en), Eigenschaften zu diesem(n) Merkmal(en) zu lesen/ändern|nur indirekt|
+|-284|Der Benutzer hat keine Berechtigung, Eigenschaften zu diesem(n) Merkmal(en) zu modifizieren|nur indirekt|
+|-283|Der Benutzer hat keine Berechtigung, Eigenschaften zu diesem(n) Merkmal(en) zu ermitteln|nur indirekt|
+|-220|Es konnte keine Merkmal-ID für die Produktbezeichnung ermittelt werden|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.1 |2013-08-07|Datentyp-Erweiterung der Rückgabespalte "Description" [von 255 auf 1000] => Anpassung der Doku\\  |
+|6.5.4 |2013-04-29|1. Fehler : Bislang wurden für den "publicuser" auch gelöschte und inaktive Elemente beachtet !\\ 2. Anpassungen des Quellcodes an den aktuellen Standard\\  |
+|5.1.4 |2006-08-14|Explizites "ORDER BY" eingefügt, um die Sortierung der Rückgabemenge zu garantieren\\  |
+|4.0.5 |2003-10-04|Neuer Parameter "StoreTreeNodeIDsInResult"\\  |
+|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_GetNodeDescriptions_Pu|im_GetNodeDescriptions_Pu im Engine Playground öffnen]]
+== cURL ==
+Unformatierte Ausgabe:
+<code bash>
+curl -X GET  'http://<partner>-<project>.dstore.de/default/engine/im_GetNodeDescriptions_Pu?NodeIDs=<value>&LanguageID=<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_GetNodeDescriptions_Pu?NodeIDs=<value>&LanguageID=<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_GetNodeDescriptions_Pu',
+		array(
+			'NodeIDs' => '<value>',
+			'LanguageID' => <value>,
+			// 'IsTreeNodeID' => 0,
+			// 'LookForProductDescriptions' => 1,
+			// 'StoreTreeNodeIDsInResult' => 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_GetNodeDescriptions_Pu">
+			<Parameters>
+				<Parameter Name="NodeIDs"><!-- varchar value --></Parameter>
+				<Parameter Name="LanguageID"><!-- smallint value --></Parameter>
+				<!-- <Parameter Name="IsTreeNodeID">0</Parameter> -->
+				<!-- <Parameter Name="LookForProductDescriptions">1</Parameter> -->
+				<!-- <Parameter Name="StoreTreeNodeIDsInResult">0</Parameter> -->
+			</Parameters>
+		</Procedure>
+	</Batch>
+</ListOfBatches></code>

Benutzer-Werkzeuge

Webseiten-Werkzeuge

Unterschiede

Seiten-Werkzeuge