Benutzer-Werkzeuge

Webseiten-Werkzeuge


engine:procedures:im_getlevels_pu

im_GetLevels_Pu

Gibt die verfügbaren Hierarchien für Artikel-Elemente aus.

HTTP-MethodGET
HTTP-AuthOptional
Tags
Engine-Kategorieitem management
Engine-TypDaten-Ermittlung
Letzte Aktualisierung7.0.7 (2015-01-29)

Parameter

Name 1) Standard-Wert Beschreibung 2) SQL-Datentyp3) ab Version
LevelNULL Optional, falls nur der Datensatz zu einer bestimmten Hierarchie ausgegeben werden soll. „IsID“ legt fest, ob man eine „LevelID“ oder eine „LevelNo“ angegeben hat.
tinyint3.5.19
IsID1 „1“ : Bei „Level“ handelt es sich um die ID einer Hierarchie („LevelID“)
„0“ : „Level“ enthält eine Hierarchie-Nummer („LevelNo“)
bit3.5.19
OrderByLevelNo0 „0“ : Keine besondere Sortierung der Rückgabemenge, d.h. im Regelfall ist das Ergebnis nach dem geclusterten Index auf „Levels“ sortiert (also nach der „LevelID“)
„1“ : Die Rückgabemenge soll nach „LevelNo“ sortiert werden
bit3.5.19

Rückgabe

(parameterunabhängig)

Spaltenname Beschreibung SQL-Datentyp4) ab Version
LevelIDID einer Hierarchie
tinyint3.5.0
LevelNoNummer einer Hierarchie. Eine höhere Nummer bedeutet eine niedrigere Hierarchie. Das „Root“-Element hat die Nummer „1“. Im Artikelbaum muß die Hierarchie-Nummer eines Nachfolger-Elementes immer höher als die seines Vorgängers sein.
tinyint3.5.0
LevelDescriptionBezeichnung der Hierarchie
varchar(100)3.5.0
DefaultSymbolIDID eines Symbols, das Elemente auf dieser Hierarchie standardmäßig zugewiesen bekommen
smallint3.5.0
DefaultTemplateIDID eines Templates, das Elemente auf dieser Hierarchie standardmäßig zugewiesen bekommen
smallint3.5.0
Sortierung der Rückgabe

wenn OrderByLevelNo = 1

  • LevelNo (aufsteigend)

Output-Parameter

Die Prozedur hat keine Output-Parameter.

Mögliche Return-Codes

Code Beschreibung Quelle 5)
-569Der Benutzer hat kein Ausführungsrecht für die Prozedurnur indirekt
-567Die Prozedur darf z. Zt. nicht ausgeführt werdennur indirekt
-566Die Prozedur darf mit den übergebenen Parametern nicht ausgeführt werdennur indirekt
-535Das Datum liegt nicht in der Vergangenheitnur indirekt
-530Der Wert ist nicht konvertierbarnur indirekt
-510Der Benutzer ist nicht registriertnur indirekt
-504Es ist ein Problem aufgetreten, das nicht gelöst werden kann, Prozedur wird daher abgebrochennur indirekt
-500Falsche Parameternur 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„Start-/Finish-Procedure“-Logik eingebaut, s. Ticket #3670
5.1.4 2006-08-14Explizites „ORDER BY“ eingefügt, um die Sortierung der Rückgabemenge zu garantieren
3.5.19 2002-06-17Erstmalig 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_GetLevels_Pu'

Mit xmllint 6) formatierte Ausgabe:

curl -X GET  'http://<partner>-<project>.dstore.de/default/engine/im_GetLevels_Pu' | 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_GetLevels_Pu',
		array(
			// 'Level' => NULL,
			// 'IsID' => 1,
			// 'OrderByLevelNo' => 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_GetLevels_Pu">
			<Parameters>
				<!-- <Parameter Name="Level">NULL</Parameter> -->
				<!-- <Parameter Name="IsID">1</Parameter> -->
				<!-- <Parameter Name="OrderByLevelNo">0</Parameter> -->
			</Parameters>
		</Procedure>
	</Batch>
</ListOfBatches>
1)
Pflichtparameter sind unterstrichen
5)
direkt meint „von der Prozedur selber“ und indirekt meint „von intern aufgerufenen Unterprozeduren“
6)
I.d.R. auf Unix-artigen Systemen bereits installiert, Bestandteil der libxml2, siehe http://www.xmlsoft.org
engine/procedures/im_getlevels_pu.txt · Zuletzt geändert: 11.01.2016 (Externe Bearbeitung)