im_GetPageTreeNodes_Ad [dstore]

Inhaltsverzeichnis

im_GetPageTreeNodes_Ad

im_GetPageTreeNodes_Ad

Gibt alle sogenannten „PageTreeNodes“ aus. Diese besitzen alle eine „TreeNodeID“ kleiner „0“. Gemeint sind Elemente, die nicht zur Artikelstruktur gehören, aber trotzdem in den Statistiken zur Basis-Kennzahl „1“ („Views“) auftauchen sollen. Da die Anwendungsfälle hierfür im Regelfall Web-SEITEN (außerhalb der Produkt-Navigation) sind, deren Aufruf man zählen möchte, wurde der Name „Page“-TreeNodes gewählt. Diese „TreeNodes“ sollten nur verwendet werden, wenn man am sogenannte „Click-Stream“ eines Besuchers interessiert ist (siehe st_GetClickStream_Ad), denn ansonsten gibt es die Tabelle „Pages“, „PagesInCategories“, „PageCategories“ und „PageVisits“, die dem Zählen von Seiten-Aufrufen dienen (siehe u.a. st_GetPages_Ad, st_GetPageVisits_Ad etc.).

HTTP-Method	GET
HTTP-Auth	Optional
Tags	[im, Get, Page, Tree, Nodes, Ad]
Engine-Kategorie	item management
Engine-Typ	Daten-Ermittlung
Letzte Aktualisierung	7.0.7 (2015-01-29)

Parameter

Name ¹⁾	Standard-Wert	Beschreibung ²⁾	SQL-Datentyp³⁾	ab Version
IncludeInactive	0	„0“ : Nur „TreeNodeID“s berücksichtigen, die aktiv sind („Active = 1“ in „TreeView“) „1“ : Auch „TreeNodeID“s berücksichtigen, die inaktiv sind („Active = 0“ in „TreeView“)	bit	3.5.0

Rückgabe

(parameterunabhängig)

Spaltenname	Beschreibung	SQL-Datentyp⁴⁾	ab Version
TreeNodeID	ID eines Elementes in „TreeView“, das NICHT zum Artikelbaum gehört. Der Wert ist daher immer kleiner als „0“	integer	3.5.0
NodeID	ID des zur „TreeNodeID“ gehörenden Elementes aus „dStore“. Wert ist ebenfalls immer kleiner als „0“	integer	3.5.0
NodeDescription	Bezeichnung der „Page“	varchar(100)	3.5.0
Deleted	Ist „TreeNodeID“ als gelöscht markiert ? („0“ : Nein, „1“ : Ja)	bit	3.5.0
Active	Ist „TreeNodeID“ z.Zt. aktiviert ? („0“ : Nein, „1“ : Ja)	bit	3.5.0
SymbolID	ID eines Symbols, mit dem die Page „NodeID“ dargestellt wird	smallint	3.5.0
LevelID	ID der Hierarchie; ist für „Page“s immer „0“ (evtl. wird später aber auch hier eine Baumstruktur erlaubt sein)	tinyint	3.5.0

Sortierung der Rückgabe

(parameterunabängige Sortierung)

TreeNodeID (absteigend)

Output-Parameter

Die Prozedur hat keine Output-Parameter.

Mögliche Return-Codes

Code	Beschreibung	Quelle ⁵⁾
-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
-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	nur indirekt
-500	Falsche Parameter	nur indirekt

XML-Schema

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

Historie

7.0.7	2015-01-29	Interne Änderung : Datentyp-Erweiterung des „ReferenceKey“ [für „_mi_StartProcedure“-Aufruf]
4.0.11	2004-03-31	1. Aufruf der Prozeduren „_mi_StartProcedure“ und „_mi_FinishProcedure“ 2. „set transaction isolation level 1“ und „set rowcount 0“ zu Beginn 3. Fehlende Doku der Rückgabemenge 4. Erklärung in der Doku, was „Page-TreeNodes“ sind
3.5.12	2001-10-17
3.5.11	2001-09-06
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:

im_GetPageTreeNodes_Ad im Engine Playground öffnen

cURL

Unformatierte Ausgabe:

curl -X GET  'http://<partner>-<project>.dstore.de/default/engine/im_GetPageTreeNodes_Ad'

Mit xmllint ⁶⁾ formatierte Ausgabe:

curl -X GET  'http://<partner>-<project>.dstore.de/default/engine/im_GetPageTreeNodes_Ad' | 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_GetPageTreeNodes_Ad',
		array(
			// 'IncludeInactive' => 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_GetPageTreeNodes_Ad">
			<Parameters>
				<!-- <Parameter Name="IncludeInactive">0</Parameter> -->
			</Parameters>
		</Procedure>
	</Batch>
</ListOfBatches>

¹⁾

Pflichtparameter sind unterstrichen

²⁾

siehe Parameter-Konventionen engine/<Prozedur-Name>

³⁾ , ⁴⁾

siehe Datentypen im Bereich "engine"

⁵⁾

direkt meint „von der Prozedur selber“ und indirekt meint „von intern aufgerufenen Unterprozeduren“

⁶⁾

I.d.R. auf Unix-artigen Systemen bereits installiert, Bestandteil der libxml2, siehe http://www.xmlsoft.org

Benutzer-Werkzeuge

Webseiten-Werkzeuge

Inhaltsverzeichnis