om_ModifyTrolleyContentInfo_Pu [dstore]

Inhaltsverzeichnis

om_ModifyTrolleyContentInfo_Pu

om_ModifyTrolleyContentInfo_Pu

Prozedur, um „TrolleyContentInformation“, also Informationen zu Positionen des Warenkorbs eines Besuchers zu verwalten.

Die Übergabe der Daten erfolgt mit Hilfe der Prozedur „if_om_ModifyTrolleyContentInfo“ (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_ModifyTrolleyContentInfo“ 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
Alias	om_ModifyTrolleyContentInformation_Pu
Tags	[om, Modify, Trolley, Content, Information, Pu]
Engine-Kategorie	order management
Engine-Typ	Daten-Änderung
Letzte Aktualisierung	7.0.7 (2015-01-29)

Parameter

Name ¹⁾	Standard-Wert	Beschreibung ²⁾	SQL-Datentyp³⁾	ab Version
UniqueID		Eindeutige ID eines Besuchers (aus „Visitors“), zu dessen „Warenkorbs-Positionen“ zusätzliche Informationen erstellt/geändert/gelöscht werden sollen	varchar(50)	5.5.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_ModifyTrolleyContentInfo“ in der Input-Schnittstelle gespeichert wurden.	tinyint	5.5.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	5.5.2
OnlyNewData	0	Gibt es zu einer Position („HTreeNodeID“) 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	5.5.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)	5.5.2
HTreeNodeID	NULL	Nur beachtet wenn „NestingLevelForInputData = NULL“ ! ID eines Elementes im historischen Artikelbaum und damit eine Warenkorbs-Position, zu der „Information“ hinterlegt werden soll (zur durch „InformationTypeID“ angegebenen Informations-Art).	integer	6.5.4
InformationTypeID	NULL	Nur beachtet wenn „NestingLevelForInputData = NULL“ ! ID eines Informations-Typs (für Warenkorbs-Positionen), auf das sich „Information“ bezieht (die zur Position „HTreeNodeID“ hinterlegt werden soll).	smallint	6.5.4
Information	NULL	Nur beachtet wenn „NestingLevelForInputData = NULL“ ! Der Wert, der zur Position „HTreeNodeID“ (zur Informations-Art „InformationTypeID“) hinterlegt werden soll ('' angeben, um eine evtl. vorhandene Information zu löschen).	varchar(1000)	6.5.4

Rückgabe

(parameterunabhängig)

Spaltenname	Beschreibung	SQL-Datentyp⁴⁾	ab Version
HTreeNodeID	ID eines Elementes aus „HistoryTreeView“ (in dieser ist die Historie des gesamten Artikelbaums abgebildet), das der Besucher „UniqueID“ in seinen Warenkorb gelegt hat und zu dem zusätzliche Informationen gespeichert/gelöscht werden sollten	integer	5.5.2
InformationTypeID	ID der Informations-Art bei der es einen Fehler gab (→ „ErrorCode“)	smallint	5.5.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	5.5.2

Output-Parameter

Die Prozedur hat keine Output-Parameter.

Mögliche Return-Codes

Code	Beschreibung	Quelle ⁵⁾
-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	nur indirekt
-502	Die Parameter-Werte der Prozedur können nicht verarbeitet werden (kein passendes Trennzeichen)	nur indirekt
-500	Falsche Parameter	direkt und indirekt
-397	Einige TrolleyContentInformation sind ungültig	nur indirekt

XML-Schema

Die Rückgabe erfolgt als XML-Dokument welches gegen das Schema Response/EngineProcedure_v1_0.xsd validiert.

Historie

7.0.7	2015-01-29	„Start-/Finish-Procedure“-Logik eingebaut, s. Ticket #3670
7.0.5	2014-05-26	Datentyp-Erweiterung von „Information“ wg. der „OrderContentInformation“-Erweiterung [Ticket #3653]
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
5.5.2	2008-10-21	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:

om_ModifyTrolleyContentInfo_Pu im Engine Playground öffnen

cURL

Unformatierte Ausgabe:

curl -X POST  'http://<partner>-<project>.dstore.de/default/engine/om_ModifyTrolleyContentInfo_Pu?UniqueID=<value>'

Mit xmllint ⁶⁾ formatierte Ausgabe:

curl -X POST  'http://<partner>-<project>.dstore.de/default/engine/om_ModifyTrolleyContentInfo_Pu?UniqueID=<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_ModifyTrolleyContentInfo_Pu',
		array(
			'UniqueID' => '<value>',
			// 'NestingLevelForInputData' => 2,
			// 'ChangeAllOrNothing' => 1,
			// 'OnlyNewData' => 0,
			// 'Country' => 'german',
			// 'HTreeNodeID' => NULL,
			// 'InformationTypeID' => NULL,
			// 'Information' => 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_ModifyTrolleyContentInfo_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="HTreeNodeID">NULL</Parameter> -->
				<!-- <Parameter Name="InformationTypeID">NULL</Parameter> -->
				<!-- <Parameter Name="Information">NULL</Parameter> -->
			</Parameters>
		</Procedure>
	</Batch>
</ListOfBatches>

¹⁾

Pflichtparameter sind unterstrichen

²⁾

siehe Parameter-Konventionen engine/<Prozedur-Name>

³⁾ , ⁴⁾

siehe Datentypen im Bereich "engine"

⁵⁾

direkt meint „von der Prozedur selber“ und indirekt meint „von intern aufgerufenen Unterprozeduren“

⁶⁾

I.d.R. auf Unix-artigen Systemen bereits installiert, Bestandteil der libxml2, siehe http://www.xmlsoft.org

Benutzer-Werkzeuge

Webseiten-Werkzeuge

Inhaltsverzeichnis