Benutzer-Werkzeuge

Webseiten-Werkzeuge


engine:procedures:im_getnodedescriptions_pu

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-MethodGET
HTTP-AuthOptional
Tags
Engine-Kategorieitem management
Engine-TypDaten-Ermittlung
Letzte Aktualisierung7.0.1 (2013-08-07)

Parameter

Name 1) Standard-Wert Beschreibung 2) SQL-Datentyp3) 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
IsTreeNodeID0 „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“)
bit3.5.0
LanguageID ID einer Sprache, in der die Bezeichung der Artikelelemente ausgegeben werden soll
smallint3.5.0
LookForProductDescriptions1 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“.
bit3.5.0
StoreTreeNodeIDsInResult0 „1“ angeben, um (nur im Fall „IsTreeNodeID = 1 !) in der Ergebnismenge statt der Spalte „NodeID“ die Spalte „TreeNodeID“ zu erhalten
bit4.0.5

Rückgabe

wenn IsTreeNodeID = 0

Spaltenname Beschreibung SQL-Datentyp4) ab Version
NodeIDID eines Artikel-Elementes, das in „NodeIDs“ bzw. „tempdb.dbo.OneID“ übergeben wurde
integer3.5.0
DescriptionBezeichnung 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-Datentyp5) ab Version
NodeIDID eines Artikel-Elementes, das zu einer der in „NodeIDs“ bzw. „tempdb.dbo.OneID“ angegebenen „TreeNodeID“s gehört
integer3.5.0
DescriptionBezeichnung 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-Datentyp6) ab Version
TreeNodeIDID eines Elementes des Artikelbaums, das in „NodeIDs“ bzw. „tempdb.dbo.OneID“ übergeben wurde
integer4.0.5
DescriptionBezeichnung 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 7)
-621Fehlender oder falscher Eintrag in PersonTypeSettingsnur indirekt
-550Fehlender oder falscher Eintrag in Settingsnur indirekt
-500Falsche Parameternur indirekt
-286Der Benutzer hat nicht die Berechtigung(en), Eigenschaften zu diesem(n) Merkmal(en) zu lesen/ändernnur indirekt
-284Der Benutzer hat keine Berechtigung, Eigenschaften zu diesem(n) Merkmal(en) zu modifizierennur indirekt
-283Der Benutzer hat keine Berechtigung, Eigenschaften zu diesem(n) Merkmal(en) zu ermittelnnur indirekt
-220Es konnte keine Merkmal-ID für die Produktbezeichnung ermittelt werdennur indirekt

XML-Schema

Die Rückgabe erfolgt als XML-Dokument welches gegen das Schema Response/EngineProcedure_v1_0.xsd validiert.

Historie

7.0.1 2013-08-07Datentyp-Erweiterung der Rückgabespalte „Description“ [von 255 auf 1000] ⇒ Anpassung der Doku
6.5.4 2013-04-291. 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-14Explizites „ORDER BY“ eingefügt, um die Sortierung der Rückgabemenge zu garantieren
4.0.5 2003-10-04Neuer Parameter „StoreTreeNodeIDsInResult“
3.5.0 2000-11-23Erstmalig 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:

cURL

Unformatierte Ausgabe:

curl -X GET  'http://<partner>-<project>.dstore.de/default/engine/im_GetNodeDescriptions_Pu?NodeIDs=<value>&LanguageID=<value>'

Mit xmllint 8) formatierte Ausgabe:

curl -X GET  'http://<partner>-<project>.dstore.de/default/engine/im_GetNodeDescriptions_Pu?NodeIDs=<value>&LanguageID=<value>' | xmllint --format -
dStore_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();
engine/execute

XML zur Ausführung mit der Methode engine/execute, z.B. per

curl --header 'Content-Type: application/xml' -X POST 'http://<partner>-<kunde>.dstore.de/default/engine/execute' -d '<xml-daten>'
<?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>
1)
Pflichtparameter sind unterstrichen
7)
direkt meint „von der Prozedur selber“ und indirekt meint „von intern aufgerufenen Unterprozeduren“
8)
I.d.R. auf Unix-artigen Systemen bereits installiert, Bestandteil der libxml2, siehe http://www.xmlsoft.org
engine/procedures/im_getnodedescriptions_pu.txt · Zuletzt geändert: 11.01.2016 (Externe Bearbeitung)