Gibt zusätzliche Informationen zu Auftragspositionen aus.
HTTP-Method | GET |
HTTP-Auth | Optional |
Alias | om_GetOrderContentInformation_Ad |
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 | ID eines Auftrags. Falls angegeben, werden Informationen zu ALLEN Positionen dieses Auftrags ermittelt. Gibt man „NULL“ an, muß „OrderContentID“ angegeben sein, oder (falls ebenfalls „NULL“) man muß „OrderID“s in „tempdb.dbo.OneID“ übergeben. | integer | 4.0.12 | |
OrderContentID | NULL | Wird nur beachtet, wenn „OrderID = NULL“ ist ! ID einer Auftrags-Position, zu der hinterlegte Informationen ermittelt werden sollen. Wird hierfür UND für „OrderID“ „NULL“ angegeben, erwartet die Prozedur „OrderID“s in „tempdb.dbo.OneID“. | integer | 4.0.12 |
InformationTypeID | NULL | ID eines Informations-Typs (für Auftrags-Positionen, s. om_GetOrderContentInfoTypes_Ad). Wenn angegeben, wird nur die Zusatz-Information zu diesem Typ zurückgegeben. | smallint | 4.0.12 |
IgnoreInformationTypeIDList | '-17¶-16¶-15' | Wird nur beachtet, wenn „InformationTypeID = NULL“ ist ! Liste von „InformationTypeID“s (durch „¶“ getrennt), die IGNORIERT werden sollen, d.h. man bekommt zu allen Informations-Typen Daten geliefert, mit Ausnahme der in diesem Parameter angegebenen. | varchar(250) | 5.1.6 |
Spaltenname | Beschreibung | SQL-Datentyp4) | ab Version |
---|---|---|---|
OrderID | ID eines Auftrags | integer | 4.0.12 |
OrderContentID | ID einer Auftrags-Position des Auftrags „OrderID“ | integer | 4.0.12 |
Position | Um die wievielte Position des Auftrags „OrderID“ handelt es sich bei „OrderContentID“ | smallint | 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 |
Information | Die zur Auftrags-Position „OrderContentID“ hinterlegt Information des Typs „InformationTypeID“ | varchar(1000) | 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 |
-502 | Die Parameter-Werte der Prozedur können nicht verarbeitet werden (kein passendes Trennzeichen) | nur indirekt |
-500 | Falsche Parameter | direkt und 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 | Anpassung der Rückgabemengen-Doku : Spalte „Information“ wurde erweitert, s. Ticket #3653 |
6.5.4 | 2013-04-29 | Anpassungen an aktuellen Code-Standard, u.a. wg. UTF8-Unterstützung |
5.1.6 | 2006-09-14 | Neuer Parameter „IgnoreInformationTypeIDList“ |
4.0.13 | 2004-05-18 | Fehler, falls eine „OrderID“ angegeben wurde |
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_GetOrderContentInfo_Ad?OrderID=<value>'
Mit xmllint 6) formatierte Ausgabe:
curl -X GET 'http://<partner>-<project>.dstore.de/default/engine/om_GetOrderContentInfo_Ad?OrderID=<value>' | 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_GetOrderContentInfo_Ad', array( 'OrderID' => <value>, // 'OrderContentID' => NULL, // 'InformationTypeID' => NULL, // 'IgnoreInformationTypeIDList' => '-17¶-16¶-15' ) ); $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_GetOrderContentInfo_Ad"> <Parameters> <Parameter Name="OrderID"><!-- integer value --></Parameter> <!-- <Parameter Name="OrderContentID">NULL</Parameter> --> <!-- <Parameter Name="InformationTypeID">NULL</Parameter> --> <!-- <Parameter Name="IgnoreInformationTypeIDList">'-17¶-16¶-15'</Parameter> --> </Parameters> </Procedure> </Batch> </ListOfBatches>