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 | |
Engine-Kategorie | item management |
Engine-Typ | Daten-Ermittlung |
Letzte Aktualisierung | 7.0.1 (2013-08-07) |
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 | |
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 |
Spaltenname | Beschreibung | SQL-Datentyp4) | 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 |
(parameterunabängige Sortierung)
Spaltenname | Beschreibung | SQL-Datentyp5) | 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 |
(parameterunabängige Sortierung)
Spaltenname | Beschreibung | SQL-Datentyp6) | 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 |
(parameterunabängige Sortierung)
Die Prozedur hat keine Output-Parameter.
Code | Beschreibung | Quelle 7) |
---|---|---|
-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 |
Die Rückgabe erfolgt als XML-Dokument welches gegen das Schema Response/EngineProcedure_v1_0.xsd validiert.
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 |
Der folgende Link öffnet in einem separaten Fenster den Engine Playground der fest mit dem dbap-demo System verbunden ist:
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 -
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();
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>