Inhaltsverzeichnis
om_GetOrderStateHistory_Pu
Ermittelt die Historie der Status-Wechsel für eine Auftrag. Dabei 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.
Anmerkung zu den Parametern „InformationTypeID“ und „Information“ :
Da man auch einem Neukunden, der noch keine Kundennummer hat (welche aber im Regelfall für die Identifizierung benötigt wird), den Status seines Auftrags präsentieren möchte, wird statt der üblichen Personen-Identifizierung quasi eine „Auftrags-Identifizierung“ (durch besagte Parameter) durchgeführt. Dazu muß natürlich zum Auftrag eine entsprechende Information hinterlegt sein, die über alle Aufträge hinweg eindeutig ist. (Sollte durch diese Parameter kein Auftrag oder mehrere Aufträge gefunden werden, gibt es daher einen Fehler.)
| HTTP-Method | GET |
| HTTP-Auth | Optional |
| Tags | |
| Engine-Kategorie | order management |
| Engine-Typ | Daten-Ermittlung |
| Letzte Aktualisierung | 4.0.12 (2004-04-30) |
Parameter
| Name 1) | Standard-Wert | Beschreibung 2) | SQL-Datentyp3) | ab Version |
|---|---|---|---|---|
| InformationTypeID | ID eines Informations-Typs (für Aufträge), auf das sich „Information“ bezieht | smallint | 3.5.7 | |
| Information | Die Information, die einen Auftrag (zu dem die Historie der Status-Wechsel ermittelt werden soll) eindeutig identifiziert (eine Art „Order-Code“) | varchar(250) | 3.5.7 | |
| LanguageID | NULL | ID einer Sprache. Angeben, um (falls vorhanden) die Übersetzungen der Status-Beschreibungen („FromOrderState_PublicDescr“ bzw. „ToOrderState_PublicDescr“) zu erhalten. | tinyint | 3.5.7 |
Rückgabe
(parameterunabhängig)
| 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 |
| FromOrderState_PublicDesc | Beschreibung des Status „FromOrderStateID“ für den Kunden. Wenn eine „LanguageID“ übergeben wurde, dann wird versucht, eine Übersetzung diese Textes zu ermitteln. | varchar(255) | 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 |
| ToOrderStateID_PublicDescr | Beschreibung des Status „ToOrderStateID“ für den Kunden. Wenn eine „LanguageID“ übergeben wurde, dann wird versucht, eine Übersetzung diese Textes zu ermitteln. | varchar(255) | 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 „dStore“-Benutzers „UserID“ | varchar(50) | 3.5.6 |
Sortierung der Rückgabe
(parameterunabängige Sortierung)
- ChangingDateAndTime (aufsteigend)
- OrderContentID (aufsteigend)
Output-Parameter
Die Prozedur hat keine Output-Parameter.
Mögliche Return-Codes
| Code | Beschreibung | Quelle 5) |
|---|---|---|
| -371 | Die angegebene Information gehört nicht eindeutig zu einem bestimmten Auftrag | nur direkt |
XML-Schema
Die Rückgabe erfolgt als XML-Dokument welches gegen das Schema Response/EngineProcedure_v1_0.xsd validiert.
Historie
| 4.0.12 | 2004-04-30 | Fehler in der Doku : Es fehlte die Rückgabespalte „UserID“ |
| 3.5.19 | 2002-06-17 | |
| 3.5.8 | 2001-05-19 | |
| 3.5.7 | 2001-05-04 | 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:
cURL
Unformatierte Ausgabe:
curl -X GET 'http://<partner>-<project>.dstore.de/default/engine/om_GetOrderStateHistory_Pu?InformationTypeID=<value>&Information=<value>'
Mit xmllint 6) formatierte Ausgabe:
curl -X GET 'http://<partner>-<project>.dstore.de/default/engine/om_GetOrderStateHistory_Pu?InformationTypeID=<value>&Information=<value>' | 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_Pu', array( 'InformationTypeID' => <value>, 'Information' => '<value>', // '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_GetOrderStateHistory_Pu"> <Parameters> <Parameter Name="InformationTypeID"><!-- smallint value --></Parameter> <Parameter Name="Information"><!-- varchar value --></Parameter> <!-- <Parameter Name="LanguageID">NULL</Parameter> --> </Parameters> </Procedure> </Batch> </ListOfBatches>