om_RemoveVoucherFromTrolley_Pu [dstore]

Inhaltsverzeichnis

om_RemoveVoucherFromTrolley_Pu

om_RemoveVoucherFromTrolley_Pu

Diese Prozedur entfernt die Zuordnung eines Gutschein-Codes zum „Warenkorb“. Dadurch entfallen natürlich auch evtl. an diesen Gutschein geknüpfte Boni (ein Rabatt z.B.).

Hintergrund : Ein einmal durch om_ValidateVoucherCode_Pu verifizierter Gutschein-Code bleibt solange an den Besucher bzw. den Warenkorb dieses Besuchers geknüpft, bis er durch eine Auftrags-Platzierung tatsächlich eingelöst wird oder seine Gültigkeit verliert. Mit dieser Prozedur hat man eine weitere Möglichkeit, die „Zuordnung“ zu entfernen (weil der Kunde z.B. einen anderen Code einlösen möchte oder den Code doch noch nicht einlösen möchte etc.).

HTTP-Method	POST
HTTP-Auth	Optional
Tags	[om, Remove, Voucher, From, Trolley, 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
VoucherCode		Ein konkreter Gutschein-Code, der (möglicherweise) aktuell mit dem Warenkorb des durch „UniqueID“ angegebenen Besuchers verknüpft ist (und entfernt werden soll). „NULL“ angeben, um ALLE zum Warenkorb zugeordneten Codes entfernen zu lassen.	varchar(50)	6.0.2
UniqueID		Eindeutige ID eines Besuchers (aus „Visitors“), zu dessen „Warenkorb“ (möglicherweise) aktuell der Gutschein-Code „VoucherCode“ hinterlegt ist (und entfernt werden soll)	varchar(50)	6.0.2

Rückgabe

Die Prozedur hat keine Rückgaben.

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	nur direkt
-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

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
6.5.1	2012-11-02	Neue Möglichkeit, „NULL“ für „VoucherCode“ angeben zu können, um ALLE zur „UniqueID“ zugeordneten Codes entfernen zu lassen [Ticket #3194]
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

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_RemoveVoucherFromTrolley_Pu im Engine Playground öffnen

cURL

Unformatierte Ausgabe:

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

Mit xmllint ⁵⁾ formatierte Ausgabe:

curl -X POST  'http://<partner>-<project>.dstore.de/default/engine/om_RemoveVoucherFromTrolley_Pu?VoucherCode=<value>&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_RemoveVoucherFromTrolley_Pu',
		array(
			'VoucherCode' => '<value>',
			'UniqueID' => '<value>'
		)
);
 
$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_RemoveVoucherFromTrolley_Pu">
			<Parameters>
				<Parameter Name="VoucherCode"><!-- varchar value --></Parameter>
				<Parameter Name="UniqueID"><!-- varchar value --></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