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-Method | GET |
HTTP-Auth | Optional |
Tags | |
Engine-Kategorie | order management |
Engine-Typ | Daten-Ermittlung |
Letzte Aktualisierung | 7.0.7 (2015-01-29) |
Name 1) | Standard-Wert | Beschreibung 2) | SQL-Datentyp3) | ab Version |
---|---|---|---|---|
OrderOrOrderContentID | NULL | 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ß) ! | integer | 3.5.6 |
IsOrderID | 1 | „0“ : Bei „OrderOrOrderContentID“ handelt es sich um die ID einer Auftragsposition „1“ : „OrderOrOrderContentID“ ist die ID eines Auftrags | bit | 3.5.6 |
FromOrderStateID | NULL | 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. | tinyint | 3.5.6 |
ToOrderStateID | NULL | 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. | tinyint | 3.5.6 |
UserID | NULL | 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. | smallint | 3.5.6 |
FromDateAndTime | NULL | Falls angegeben, gibt die Prozedur nur Status-Wechsel aus, die AB diesem Zeitpunkt vorgenommen wurden | datetime | 3.5.6 |
ToDateAndTime | NULL | Falls angegeben, gibt die Prozedur nur Status-Wechsel aus, die BIS zu diesem Zeitpunkt vorgenommen wurden | datetime | 3.5.6 |
Spaltenname | Beschreibung | SQL-Datentyp4) | ab Version |
---|---|---|---|
OrderID | ID des Auftrags, zu dem die Position „OrderContentID“ gehört | integer | 3.5.6 |
OrderContentID | ID einer Position des Auftrags „OrderID“, dessen Status von „FromOrderStateID“ nach „ToOrderStateID“ gewechselt wurde | integer | 3.5.6 |
FromOrderStateID | ID eines Auftrags(-Positions)-Status VON dem die Position „OrderContentID“ (in den Status „ToOrderStateID“) gewechselt wurde | tinyint | 3.5.6 |
FromOrderState | Bezeichnung des Status „FromOrderStateID“ | varchar(50) | 3.5.6 |
ToOrderStateID | ID eines Auftrags(-Positions)-Status AUF den die Position „OrderContentID“ (vom Status „FromOrderStateID“) gesetzt wurde | tinyint | 3.5.6 |
ToOrderState | Bezeichnung des Status „ToOrderStateID“ | varchar(50) | 3.5.6 |
UserID | ID des „dStore“-Benutzers (der in „UserInfo“ registriert ist) der den Status-Wechsel vorgenommen hat | smallint | 3.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 | bit | 3.5.6 |
ChangingDateAndTime | Wann wurde der Status-Wechsel durchgeführt | datetime | 3.5.6 |
ChangingDateAndTime_char | „ChangingDateAndTime“ als String im Format : „15.03.2001 20:48:13“ | varchar(30) | 3.5.6 |
UserName | Name des Benutzers „UserID“ | varchar(50) | 3.5.6 |
(parameterunabängige Sortierung)
Die Prozedur hat keine Output-Parameter.
Code | Beschreibung | Quelle 5) |
---|---|---|
-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 |
Die Rückgabe erfolgt als XML-Dokument welches gegen das Schema Response/EngineProcedure_v1_0.xsd validiert.
7.0.7 | 2015-01-29 | Interne Änderung : Datentyp-Erweiterung des „ReferenceKey“ [für „_mi_StartProcedure“-Aufruf] |
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 |
4.0.1 | 2003-05-16 | Falsche Index-Angabe für „OrderStateHistory“ in einem Fall |
3.5.7 | 2001-05-04 | |
3.5.6 | 2001-04-17 | Erstmalig in dieser Version erstellt |
Der folgende Link öffnet in einem separaten Fenster den Engine Playground der fest mit dem dbap-demo System verbunden ist:
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 -
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();
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>