om_GetOrderStatesInCats_Ad [dstore]

Inhaltsverzeichnis

om_GetOrderStatesInCats_Ad

om_GetOrderStatesInCats_Ad

Gibt die Zuordnungen von Auftrags-Status in Kategorien aus.

Anmerkung : Es werden grundsätzlich nur „OrderStateID“s, die kleiner als „250“ sind, ausgegeben, da alle IDs ab „250“ für interne Zwecke reserviert sind !

HTTP-Method	GET
HTTP-Auth	Optional
Alias	om_GetOrderStatesInCategories_Ad
Tags	[om, Get, Order, States, In, Categories, Ad]
Engine-Kategorie	order management
Engine-Typ	Daten-Ermittlung
Letzte Aktualisierung	7.0.7 (2015-01-29)

Parameter

Name ¹⁾	Standard-Wert	Beschreibung ²⁾	SQL-Datentyp³⁾	ab Version
OrderStateCategoryID	NULL	ID einer Kategorie von Auftrags-(Positions-)Status. Wenn angegeben, werden nur die Auftrags-Status ermittelt, die dieser Kategorie zugeordnet sind.	tinyint	3.5.21
OrderBy	1	Wie soll die Rückgabemenge sortiert werden (⇒ siehe Rückgabemengen-Sortierung) ?	tinyint	3.5.21
Active	NULL	Filterung nach den Auftrags-Status : „NULL“ : Alle Status berücksichtigen „1“ : Nur die aktiven oder „0“ : nur die inaktiven Status beachten	tinyint	3.5.21

Rückgabe

(parameterunabhängig)

Spaltenname	Beschreibung	SQL-Datentyp⁴⁾	ab Version
SortNo⁵⁾	Wird nicht ausgegeben, sondern nur zur Sortierung verwendet. Bestimmt die Reihenfolge von „OrderStateID“ innerhalb aller Auftrags-(Positions-)Status, die der Kategorie „OrderStateCategoryID“ zugeordnet sind.	tinyint	3.5.21
OrderStateCategoryID	ID einer Kategorie von Auftrags-(Positions-)Status	tinyint	3.5.21
OrderStateCategory	Bezeichnung der Kategorie „OrderStateCategoryID“	varchar(50)	3.5.21
OrderStateCategoryDescription	Beschreibung, welche Auftrags-Status unter dieser Kategorie zusammengefaßt werden können (also quasi welchen Sinn die Kategorie hat).	varchar(255)	3.5.21
OrderStateID	ID eines Auftrags-(Positions-)Status, der der Kategorie „OrderStateCategoryID“ zugeordnet ist	tinyint	3.5.21
OrderState	Bezeichnung des Status „OrderStateID“	varchar(50)	3.5.21
PublicDescription	Beschreibung des Status „OrderStateID“ für den Kunden	varchar(255)	3.5.21
Active	Der Status „OrderStateID“ ist… „0“ : inaktiv „1“ : aktiv	tinyint	3.5.21

Sortierungen der Rückgabe

wenn OrderBy = 1

OrderStateCategory (aufsteigend)
SortNo (aufsteigend)
OrderState (aufsteigend)

wenn OrderBy <> 1

OrderState (aufsteigend)
OrderStateCategory (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.2	2006-06-26	Berücksichtigung, daß ab 5.1.2 die „OrderStateID“s größer „249“ für interne Zwecke reserviert sind
4.0.14	2004-06-03	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.21	2002-08-06	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:

om_GetOrderStatesInCats_Ad im Engine Playground öffnen

cURL

Unformatierte Ausgabe:

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

Mit xmllint ⁷⁾ formatierte Ausgabe:

curl -X GET  'http://<partner>-<project>.dstore.de/default/engine/om_GetOrderStatesInCats_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'),
	'om_GetOrderStatesInCats_Ad',
		array(
			// 'OrderStateCategoryID' => NULL,
			// 'OrderBy' => 1,
			// 'Active' => NULL
		)
);
 
$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="om_GetOrderStatesInCats_Ad">
			<Parameters>
				<!-- <Parameter Name="OrderStateCategoryID">NULL</Parameter> -->
				<!-- <Parameter Name="OrderBy">1</Parameter> -->
				<!-- <Parameter Name="Active">NULL</Parameter> -->
			</Parameters>
		</Procedure>
	</Batch>
</ListOfBatches>

¹⁾

Pflichtparameter sind unterstrichen

²⁾

siehe Parameter-Konventionen engine/<Prozedur-Name>

³⁾ , ⁴⁾

siehe Datentypen im Bereich "engine"

⁵⁾

Spalte wird nicht zurückgegeben und ist hier nur aus Dokumentationsgründen aufgeführt.

⁶⁾

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