im_GetLevels_Ad [dstore]

Inhaltsverzeichnis

im_GetLevels_Ad

im_GetLevels_Ad

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

HTTP-Method	GET
HTTP-Auth	Optional
Tags	[im, Get, Levels, 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
Level	NULL	Optional, falls nur der Datensatz zu einer bestimmten Hierarchie ausgegeben werden soll. „IsID“ legt fest, ob man eine „LevelID“ oder eine „LevelNo“ angegeben hat.	tinyint	3.5.0
IsID	1	„0“ : Bei „Level“ handelt es sich um die ID einer Hierarchie („LevelID“) „1“ : „Level“ enthält eine Hierarchie-Nummer („Level“)	bit	3.5.0
OrderByLevelNo	0	„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	bit	3.5.0

Rückgabe

(parameterunabhängig)

Spaltenname	Beschreibung	SQL-Datentyp⁴⁾	ab Version
LevelID	ID einer Hierarchie	tinyint	3.5.0
LevelNo	Nummer 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.	tinyint	3.5.0
LevelDescription	Bezeichnung der Hierarchie	varchar(100)	3.5.0
DefaultSymbolID	ID eines Symbols, das Elemente auf dieser Hierarchie per default zugewiesen bekommen	smallint	3.5.0
DefaultTemplateID	ID eines Templates, das Elemente auf dieser Hierarchie per default zugewiesen bekommen	smallint	3.5.0

Sortierungen der Rückgabe

wenn OrderByLevelNo = 0

LevelID (aufsteigend)

wenn OrderByLevelNo = 1

LevelNo (aufsteigend)

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]
5.1.4	2006-08-14	Explizites „ORDER BY“ eingefügt, um die Sortierung der Rückgabemenge zu garantieren
4.0.11	2004-03-31	1. Aufruf der Prozeduren „_mi_StartProcedure“ und „_mi_FinishProcedure“ 2. Ausführen von „set transaction isolation level 1“ und „set rowcount 0“ zu Beginn der Prozedur 3. Fehlende Doku der Rückgabemenge
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_GetLevels_Ad im Engine Playground öffnen

cURL

Unformatierte Ausgabe:

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

Mit xmllint ⁶⁾ formatierte Ausgabe:

curl -X GET  'http://<partner>-<project>.dstore.de/default/engine/im_GetLevels_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_GetLevels_Ad',
		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_Ad">
			<Parameters>
				<!-- <Parameter Name="Level">NULL</Parameter> -->
				<!-- <Parameter Name="IsID">1</Parameter> -->
				<!-- <Parameter Name="OrderByLevelNo">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