Benutzer-Werkzeuge

Webseiten-Werkzeuge


engine:procedures:om_getorderstatehistory_ad

om_GetOrderStateHistory_Ad

Ermittelt, wann sich Auftrags-Status (besser : Status von Auftrags-Positionen !) zu Bestellungen geändert haben.

Anmerkung zum Parameter „OrderOrOrderContentID“ :
Wird die ID eines Auftrags angegeben (also „IsOrderID = 1“), werden sowohl Status-Wechsel ermittelt, die für ALLE Positionen dieses Auftrags vorgenommen wurden als auch solche, die für wenigstens EINE der Auftragspositionen durchgeführt wurden.
Bei Angabe einer Auftragsposition (d.h. „IsOrderID = 0“) ermittelt die Prozedur sowohl Status-Wechsel, die für diese Position vorgenommen wurden als auch Wechsel, die für den gesamten Auftrag (d.h. für alle Positionen des Auftrags) durchgeführt wurden.

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

Parameter

Name 1) Standard-Wert Beschreibung 2) SQL-Datentyp3) ab Version
OrderOrOrderContentIDNULL ID eines Auftrags bzw. einer Auftragsposition (je nach „IsOrderID“), für die die Historie der Statuswechsel ermittelt werden soll. Ist „NULL“ angegeben, werden ALLE Aufträge berücksichtigt (d.h. die Rückgabemenge ist u.U. SEHR groß) !
integer3.5.6
IsOrderID1 „0“ : Bei „OrderOrOrderContentID“ handelt es sich um die ID einer Auftragsposition
„1“ : „OrderOrOrderContentID“ ist die ID eines Auftrags
bit3.5.6
FromOrderStateIDNULL ID eines Auftrags-Status (besser : Status einer Auftrags-Position !). Falls angegeben, werden nur Datensätze ausgegeben, die einen Wechsel VON diesem Status in einen anderen darstellen.
tinyint3.5.6
ToOrderStateIDNULL ID eines Auftrags-Status (besser : Status einer Auftrags-Position !). Falls angegeben, werden nur Datensätze ausgegeben, die einen Wechsel von einem beliebigen Status in DIESEN Status darstellen.
tinyint3.5.6
UserIDNULL ID eines „dStore“-Benutzers, der in „UserInfo“ registriert ist (siehe mi_GetUserInfo_Ad). Wird dieser Parameter angegeben, werden nur Status-Wechsel ermittelt, die dieser Benutzer vorgenommen hat.
smallint3.5.6
FromDateAndTimeNULL Falls angegeben, gibt die Prozedur nur Status-Wechsel aus, die AB diesem Zeitpunkt vorgenommen wurden
datetime3.5.6
ToDateAndTimeNULL Falls angegeben, gibt die Prozedur nur Status-Wechsel aus, die BIS zu diesem Zeitpunkt vorgenommen wurden
datetime3.5.6

Rückgabe

(parameterunabhängig)

Spaltenname Beschreibung SQL-Datentyp4) ab Version
OrderIDID des Auftrags, zu dem die Position „OrderContentID“ gehört
integer3.5.6
OrderContentIDID einer Position des Auftrags „OrderID“, dessen Status von „FromOrderStateID“ nach „ToOrderStateID“ gewechselt wurde
integer3.5.6
FromOrderStateIDID eines Auftrags(-Positions)-Status VON dem die Position „OrderContentID“ (in den Status „ToOrderStateID“) gewechselt wurde
tinyint3.5.6
FromOrderStateBezeichnung des Status „FromOrderStateID“
varchar(50)3.5.6
ToOrderStateIDID eines Auftrags(-Positions)-Status AUF den die Position „OrderContentID“ (vom Status „FromOrderStateID“) gesetzt wurde
tinyint3.5.6
ToOrderStateBezeichnung des Status „ToOrderStateID“
varchar(50)3.5.6
UserIDID des „dStore“-Benutzers (der in „UserInfo“ registriert ist) der den Status-Wechsel vorgenommen hat
smallint3.5.6
CompleteOrder„0“ : Es wurde nur der Status der Position „OrderContentID“ des Auftrags „OrderID“ geändert
„1“ : Der Status-Wechsel wurde für ALLE Positionen des Auftrags „OrderID“ vorgenommen
bit3.5.6
ChangingDateAndTimeWann wurde der Status-Wechsel durchgeführt
datetime3.5.6
ChangingDateAndTime_char„ChangingDateAndTime“ als String im Format : „15.03.2001 20:48:13“
varchar(30)3.5.6
UserNameName des Benutzers „UserID“
varchar(50)3.5.6
Sortierung der Rückgabe

(parameterunabängige Sortierung)

  • OrderID (aufsteigend)
  • ChangingDateAndTime (aufsteigend)
  • OrderContentID (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-29Interne Änderung : Datentyp-Erweiterung des „ReferenceKey“ [für „_mi_StartProcedure“-Aufruf]
4.0.14 2004-06-031. 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
4.0.1 2003-05-16Falsche Index-Angabe für „OrderStateHistory“ in einem Fall
3.5.7 2001-05-04
3.5.6 2001-04-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/om_GetOrderStateHistory_Ad'

Mit xmllint 6) formatierte Ausgabe:

curl -X GET  'http://<partner>-<project>.dstore.de/default/engine/om_GetOrderStateHistory_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_GetOrderStateHistory_Ad',
		array(
			// 'OrderOrOrderContentID' => NULL,
			// 'IsOrderID' => 1,
			// 'FromOrderStateID' => NULL,
			// 'ToOrderStateID' => NULL,
			// 'UserID' => NULL,
			// 'FromDateAndTime' => NULL,
			// 'ToDateAndTime' => 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_GetOrderStateHistory_Ad">
			<Parameters>
				<!-- <Parameter Name="OrderOrOrderContentID">NULL</Parameter> -->
				<!-- <Parameter Name="IsOrderID">1</Parameter> -->
				<!-- <Parameter Name="FromOrderStateID">NULL</Parameter> -->
				<!-- <Parameter Name="ToOrderStateID">NULL</Parameter> -->
				<!-- <Parameter Name="UserID">NULL</Parameter> -->
				<!-- <Parameter Name="FromDateAndTime">NULL</Parameter> -->
				<!-- <Parameter Name="ToDateAndTime">NULL</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/om_getorderstatehistory_ad.txt · Zuletzt geändert: 11.01.2016 (Externe Bearbeitung)