om_GetOrderStates_Ad [dstore]

Inhaltsverzeichnis

om_GetOrderStates_Ad

om_GetOrderStates_Ad

Gibt alle Status zurück, die Bestell-/Auftrags-Positionen annehmen können.

Anmerkung : Es werden 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
Tags	[om, Get, Order, States, 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
Active	NULL	„NULL“ : Alle Status berücksichtigen „1“ : Nur die aktiven Status zurückgeben „0“ : Nur die inaktiven Status beachten	tinyint	3.5.21
LanguageID	NULL	ID einer Sprache, in der die öffentliche Beschreibung des „OrderState“ („PublicDescription“, s. Rückgabemenge) ausgegeben werden soll	tinyint	5.1.0

Rückgabe

(parameterunabhängig)

Spaltenname	Beschreibung	SQL-Datentyp⁴⁾	ab Version
OrderStateID	ID eines Auftrags-(Positions-)Status	tinyint	3.5.0
OrderState	Bezeichnung des Status „OrderStateID“	varchar(50)	3.5.0
PublicDescription	Beschreibung des Status „OrderStateID“ für den Kunden. Wenn eine „LanguageID“ übergeben wurde, dann wird versucht, eine Übersetzung dieses Textes zu ermitteln.	varchar(255)	3.5.6
Active	Der Status „OrderStateID“ ist… „0“ : inaktiv „1“ : aktiv	bit	3.5.21
ChangeOrderStateTriggerID	ID eines „TRI-Trigger“, der bei einem Wechsel in den Status „OrderStateID“ ausgelöst werden soll (s. om_GetChangeOStateTrigger_Ad)	smallint	7.0.3

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]
7.0.3	2013-12-13	Neue Rückgabespalte „ChangeOrderStateTriggerID“
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
5.1.0	2006-02-08	Neuer Parameter „LanguageID“
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
3.5.6	2001-04-17
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:

om_GetOrderStates_Ad im Engine Playground öffnen

cURL

Unformatierte Ausgabe:

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

Mit xmllint ⁶⁾ formatierte Ausgabe:

curl -X GET  'http://<partner>-<project>.dstore.de/default/engine/om_GetOrderStates_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_GetOrderStates_Ad',
		array(
			// 'Active' => NULL,
			// 'LanguageID' => 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_GetOrderStates_Ad">
			<Parameters>
				<!-- <Parameter Name="Active">NULL</Parameter> -->
				<!-- <Parameter Name="LanguageID">NULL</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