Gibt zusätzliche Informationen zu Positionen eines Auftrags (nach erfolgreicher Identifizierung des Auftraggebers) aus.
HTTP-Method | GET |
HTTP-Auth | Optional |
Alias | om_GetOrderContentInformation_Pu |
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, sofern die identifizierte Person der Auftraggeber ist. Gibt man „NULL“ an, muß „OrderContentID“ angegeben sein (sonst gibt es einen Fehler) ! | integer | 5.5.1 | |
OrderContentID | NULL | Wird nur beachtet, wenn „OrderID = NULL“ ist ! ID einer Auftrags-Position, zu der hinterlegte Informationen ermittelt werden sollen. Das geht natürlich nur, wenn die identifizierte Person auch Auftraggeber ist. | integer | 5.5.1 |
PersonIdentificationValues | Liste (durch '¶' getrennt) von Werten, die den Auftraggeber identifizieren. Diese Werte müssen Eigenschaften zu den Merkmal-IDs sein, die in „PersonTypeSettings“ zur „PersonTypeID“ zum Schlüssel „PersonIdentificationIDs“ hinterlegt sind. | varchar(255) | 5.5.1 | |
PersonTypeID | ID des Personen-Typs dem die zu identifizierende Person angehört. Dieser muß bei einer Identifizierung immer mit angegeben werden, da die Merkmale zur Identifizierung pro Personentyp variieren können. | tinyint | 5.5.1 | |
InformationTypeIDList | NULL | Möchte man nur die Daten zu bestimmten Informations-Typen haben, kann man die entsprechenden IDs (durch „¶“ getrennt) hier übergeben. Achtung : Aus technischen Gründen dürfen maximal 253 Zeichen übergeben werden ! | varchar(255) | 5.5.1 |
Spaltenname | Beschreibung | SQL-Datentyp4) | ab Version |
---|---|---|---|
OrderID | ID eines Auftrags | integer | 5.5.1 |
OrderContentID | ID einer Auftrags-Position des Auftrags „OrderID“ | integer | 5.5.1 |
Position | Um die wievielte Position des Auftrags „OrderID“ handelt es sich bei „OrderContentID“ | smallint | 5.5.1 |
InformationTypeID | ID eines Informationstyps, also um was es sich bei der Zusatz-Information „Information“ handelt | smallint | 5.5.1 |
InformationType | Bezeichnung der „InformationTypeID“ | varchar(100) | 5.5.1 |
Information | Die zur Auftrags-Position „OrderContentID“ hinterlegt Information des Typs „InformationTypeID“ | varchar(1000) | 5.5.1 |
(parameterunabängige Sortierung)
Die Prozedur hat keine Output-Parameter.
Code | Beschreibung | Quelle 5) |
---|---|---|
-660 | Identifikation fehlgeschlagen | nur indirekt |
-621 | Fehlender oder falscher Eintrag in PersonTypeSettings | nur indirekt |
-599 | Lizenz ist ungültig oder abgelaufen | nur indirekt |
-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 | direkt und indirekt |
-502 | Die Parameter-Werte der Prozedur können nicht verarbeitet werden (kein passendes Trennzeichen) | nur indirekt |
-500 | Falsche Parameter | direkt und indirekt |
-343 | Nicht öffentliche Informationen zum Auftrag können nur vom Auftraggeber/Administrator erfragt werden | nur direkt |
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 |
6.0.0 | 2010-03-26 | Fehler im Fall „OrderID = NULL“ und angegebener „OrderContentID“ : es wurden doch ALLE Positionen des zugehörigen Auftrags zurückgegeben |
5.5.1 | 2008-07-29 | 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_Pu?OrderID=<value>&PersonIdentificationValues=<value>&PersonTypeID=<value>'
Mit xmllint 6) formatierte Ausgabe:
curl -X GET 'http://<partner>-<project>.dstore.de/default/engine/om_GetOrderContentInfo_Pu?OrderID=<value>&PersonIdentificationValues=<value>&PersonTypeID=<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_Pu', array( 'OrderID' => <value>, 'PersonIdentificationValues' => '<value>', 'PersonTypeID' => <value>, // 'OrderContentID' => NULL, // 'InformationTypeIDList' => 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_GetOrderContentInfo_Pu"> <Parameters> <Parameter Name="OrderID"><!-- integer value --></Parameter> <Parameter Name="PersonIdentificationValues"><!-- varchar value --></Parameter> <Parameter Name="PersonTypeID"><!-- tinyint value --></Parameter> <!-- <Parameter Name="OrderContentID">NULL</Parameter> --> <!-- <Parameter Name="InformationTypeIDList">NULL</Parameter> --> </Parameters> </Procedure> </Batch> </ListOfBatches>