Prozedur um „TrolleyInformation“, also Informationen zu einem Warenkorb zu verwalten.
Die Übergabe der Daten erfolgt mit Hilfe der Prozedur „if_om_ModifyTrolleyInformation“ (siehe Doku dieser Prozedur). Der „NestingLevel“, zu dem die Daten übergeben wurden, liefert besagte Prozedur über ihren Ausgabeparameter „InputNestingLevel“, und dieser Wert ist dann hier in „NestingLevelForInputData“ anzugeben.
Besonderheit : Ruft man „if_om_ModifyTrolleyInformation“ und diese Prozedur hier DIREKT (d.h. NICHT innerhalb einer anderen Prozedur) auf, kann man vom Wert „2“ ausgehen (weil immer nach der Logik „<aktueller NestingLevel> + 1“ verfahren wird), d.h. in so einem Fall braucht der Parameter gar nicht angegeben zu werden (weil „2“ der „default“-Wert ist).
HTTP-Method | POST |
HTTP-Auth | Optional |
Tags | |
Engine-Kategorie | order management |
Engine-Typ | Daten-Änderung |
Letzte Aktualisierung | 7.0.7 (2015-01-29) |
Name 1) | Standard-Wert | Beschreibung 2) | SQL-Datentyp3) | ab Version |
---|---|---|---|---|
UniqueID | Eindeutige ID eines Besuchers (aus „Visitors“), zu dessen Warenkorbs zusätzliche Informationen erstellt/geändert/gelöscht werden sollen | varchar(50) | 6.0.2 | |
NestingLevelForInputData | 2 | Muß nur übergeben werden, wenn die Prozedur nicht direkt aufgerufen wird (s. Beschreibung). Gibt an, zu welchem „nesting level“ die Daten vorher durch „if_om_ModifyTrolleyInformation“ in der Input-Schnittstelle gespeichert wurden. | tinyint | 6.0.2 |
ChangeAllOrNothing | 1 | Falls Fehler auftreten, sollen dann die Änderungen der Informationen, zu denen es keinen Fehler gab, durchgeführt werden („0“) oder nicht („1“) ? | bit | 6.0.2 |
OnlyNewData | 0 | Gibt es zu einem Warenkorb („VisitorID“) und einer „InformationTypeID“ bereits Daten, werden diese überschrieben. Wird hier „1“ übergeben (nur wenn man sicher ist !), besagt dies, daß es keine bestehenden Daten gibt (⇒ kleiner Performance-Vorteil). | bit | 6.0.2 |
Country | 'german' | Gibt an, in welchem Format eine „Information“ angegeben ist, falls es sich um eine Datums-Angabe handelt : - 'german' : Tag-Monat-Jahr (Standardwert) - es wird auch „Germany“ akzeptiert - 'english' : Monat-Tag-Jahr - es wird auch „England“ akzeptiert | varchar(10) | 6.0.2 |
InformationTypeID | NULL | Nur beachtet wenn „NestingLevelForInputData = NULL“ ! ID eines Informations-Typs (für Warenkörbe), auf das sich „Information“ bezieht (die zum Warenkorb des Besuchers „UniqueID“ hinterlegt werden soll). | smallint | 6.5.4 |
Information | NULL | Nur beachtet wenn „NestingLevelForInputData = NULL“ ! Der Wert, der zum Warenkorb des Besuchers „UniqueID“ (zur Informations-Art „InformationTypeID“) hinterlegt werden soll ('' angeben, um eine evtl. vorhandene Information zu löschen). | varchar(1000) | 6.5.4 |
Spaltenname | Beschreibung | SQL-Datentyp4) | ab Version |
---|---|---|---|
VisitorID | ID des zur „UniqueID“ korrespondierenden Besuchers | integer | 6.0.2 |
InformationTypeID | ID der Informations-Art bei der es einen Fehler gab (→ „ErrorCode“) | smallint | 6.0.2 |
ErrorCode | Dieser Code gibt Auskunft über die Ursache des Fehlers. Folgende Werte sind möglich : - „1“ : Die „Information“ entspricht nicht der zur „InformationTypeID“ konfigurierten „FieldTypeID“, d.h. das Format des Wertes ist ungültig | tinyint | 6.0.2 |
Die Prozedur hat keine Output-Parameter.
Code | Beschreibung | Quelle 5) |
---|---|---|
-602 | Zur defaultUniqueID („VisitorID = -2“) können keinerlei Daten gespeichert oder verändert werden | direkt und 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 |
-389 | Einige TrolleyInformation sind ungültig | 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 | „Start-/Finish-Procedure“-Logik eingebaut, s. Ticket #3670 |
7.0.5 | 2014-05-26 | Datentyp des Parameters „Information“ erweitert |
7.0.0 | 2013-06-04 | „NestingLevelForInputData“ hat jetzt einen default-Wert [„2“] |
6.5.4 | 2013-04-29 | 1. Änderung der Prozedurdokumentation - Direkte Aufrufer dürfen nun davon ausgehen, dass sie „NestingLevelForInputData“ „hart“ mit dem Wert „2“ belegen können 2. Neue Parameter „InformationTypeID“ und „Information“ |
6.0.6 | 2012-03-01 | Beachtung des neuen, speziellen Besuchers „defaultUniqueID“ - für den keine Daten-Speicherung/-Änderung erlaubt ist |
6.0.2 | 2011-06-08 | 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 POST 'http://<partner>-<project>.dstore.de/default/engine/om_ModifyTrolleyInformation_Pu?UniqueID=<value>'
Mit xmllint 6) formatierte Ausgabe:
curl -X POST 'http://<partner>-<project>.dstore.de/default/engine/om_ModifyTrolleyInformation_Pu?UniqueID=<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_ModifyTrolleyInformation_Pu', array( 'UniqueID' => '<value>', // 'NestingLevelForInputData' => 2, // 'ChangeAllOrNothing' => 1, // 'OnlyNewData' => 0, // 'Country' => 'german', // 'InformationTypeID' => NULL, // 'Information' => 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_ModifyTrolleyInformation_Pu"> <Parameters> <Parameter Name="UniqueID"><!-- varchar value --></Parameter> <!-- <Parameter Name="NestingLevelForInputData">2</Parameter> --> <!-- <Parameter Name="ChangeAllOrNothing">1</Parameter> --> <!-- <Parameter Name="OnlyNewData">0</Parameter> --> <!-- <Parameter Name="Country">'german'</Parameter> --> <!-- <Parameter Name="InformationTypeID">NULL</Parameter> --> <!-- <Parameter Name="Information">NULL</Parameter> --> </Parameters> </Procedure> </Batch> </ListOfBatches>