Gibt zusätzliche Informationen zu einer (oder mehreren) Bestellung(en) aus.
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 |
---|---|---|---|---|
OrderID | NULL | ID eines Auftrags, zu dem man sich die hinterlegten (Zusatz-)Informationen anzeigen lassen möchte. Wird „NULL“ übergeben, erwartet die Prozedur „OrderID“s in „tempdb.dbo.OneID“. | integer | 4.0.12 |
InformationTypeID | NULL | ID eines Informations-Typs (für Aufträge). Wenn angegeben, wird nur die Zusatz-Information zu diesem Typ zurückgegeben | smallint | 4.0.12 |
Spaltenname | Beschreibung | SQL-Datentyp4) | ab Version |
---|---|---|---|
OrderID | ID eines Auftrags (also entweder „OrderID“ bzw. eine ID, die in „tempdb.dbo.OneID“ übergeben wurde) | integer | 4.0.12 |
InformationTypeID | ID eines Informationstyps, also um was es sich bei der Zusatz-Information „Information“ handelt | smallint | 4.0.12 |
InformationType | Bezeichnung der „InformationTypeID“ | varchar(100) | 4.0.12 |
PersonCharacteristicID | ID eines Merkmals, das zur „InformationTypeID“ korrespondiert. Hintergrund : Man möchte im Auftrag die Eigenschaft des Auftraggebers zu diesem Merkmal zum Zeitpunkt der Auftragserstellung speichern (denn die Eigenschaft könnte ja geändert werden !) | smallint | 4.0.12 |
Information | Die zum Auftrag „OrderID“ hinterlegte Information | varchar(1000) | 4.0.12 |
CreatedAtDateAndTime | Wann wurde die Information „Information“ zur „OrderID“ hinterlegt ? Anmerkung : Für Daten, die vor dem Einspielen des Updates 4.0.12 angelegt wurden, existiert diese Information nicht - in diesem Fall wird hier „NULL“ zurückgegeben ! | datetime | 4.0.12 |
CreatedByUserID | ID des „dStore“-Benutzers (der in „UserInfo“ registriert ist) der die Information hinterlegt hat. Anmerkung : Für Daten, die vor dem Einspielen des Updates 4.0.12 angelegt wurden, existiert diese Information nicht - in diesem Fall steht hier „NULL“ ! | smallint | 4.0.12 |
(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] |
7.0.5 | 2014-05-26 | Dokumentation bzgl Datentyp der Rückgabespalte „Information“ angepasst |
5.1.5 | 2006-08-29 | Explizites „ORDER BY“ eingefügt, um die Sortierung der Rückgabemenge zu garantieren |
4.0.12 | 2004-04-30 | 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_GetOrderInformation_Ad'
Mit xmllint 6) formatierte Ausgabe:
curl -X GET 'http://<partner>-<project>.dstore.de/default/engine/om_GetOrderInformation_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_GetOrderInformation_Ad', array( // 'OrderID' => NULL, // 'InformationTypeID' => 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_GetOrderInformation_Ad"> <Parameters> <!-- <Parameter Name="OrderID">NULL</Parameter> --> <!-- <Parameter Name="InformationTypeID">NULL</Parameter> --> </Parameters> </Procedure> </Batch> </ListOfBatches>