om_ValidateVoucherCode_Pu [dstore]

Inhaltsverzeichnis

om_ValidateVoucherCode_Pu

om_ValidateVoucherCode_Pu

Überprüft die Gültigkeit eines Gutschein-Codes und hinterlegt ihn bei Erfolg zu einem gegebenen Besucher (und damit quasi zu dessen „Warenkorb“).
Die Hinterlegung des Gutschein-Codes (nach erfolgreicher Validierung) zum Besucher hat den Sinn, daß der dadurch entstehende
„Benefit“ (i.d.R. ein Rabatt) für den Warenkorb des Besuchers berücksichtigt werden kann (s. om_GetTrolleySurcharges_Pu).

Hinweise :

1.) Falls in „Settings“ der Wert „1“ zum Schlüssel „CampaignSurchargesEnabled“ konfiguriert ist, wird ein evtl. zur Gutschein-Aktion („VoucherTypeID“, zu der „VoucherCode“ gehört) hinterlegter „Benefit“ IGNORIERT !
Anmerkung : Gutschein-Codes können aber sehr wohl Bestandteil von Bedingungen einer Verkaufs-Aktion sein, die ihrerseits einen „Benefit“ hat - somit ist letztlich dieselbe Funktionalität möglich wie in dem Fall, daß NICHT „1“ zu „CampaignSurchargesEnabled“ konfiguriert ist.

2.) Weil die erfolgreiche Validierung eine schreibende Operation zur Folge hat, darf auch diese (eigentlich ja nur „lesende“) Prozedur NICHT mit der „defaultUniqueID“ aufgerufen werden !

3.) Eine erfolgreiche Validierung bedeutet nicht, daß der Gutschein-Code auch tatsächlich beim Platzieren des Auftrags (durch om_CopyFromTrolleyToOrder_Pu) eingelöst werden kann, da ja z.B. in der Zwischenzeit (Zeit zwischen Validierung durch diese Prozedur und Auftrags-Anlage) die maximale Anzahl an Einlösungen für diesen Code erreicht werden kann !

HTTP-Method	POST
HTTP-Auth	Optional
Tags	[om, Validate, Voucher, Code, 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“), der den zu validierenden „VoucherCode“ angegeben hat	varchar(50)	6.0.2
VoucherCode		Ein konkreter Gutschein-Code, für den kontrolliert werden soll, ob er gültig und (noch) einlösbar ist	varchar(50)	6.0.2
PersonID	NULL	(Optional) ID einer zum Besucher (zuvor durch pm_CheckPersonIdentity_Pu) identifizierten Person. Nur wenn hier eine ID übergeben wird, kann bei der Validierung auch die Beschränkung, wie oft eine Person einen Code einlösen darf, beachtet werden.	integer	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 ⁴⁾
-1305	Validierung fehlgeschlagen, der Code zur Zeit inaktiv ist	nur indirekt
-1304	Validierung fehlgeschlagen, da die maximale Menge an Einlösungen der Person für diesen Code erreicht	nur indirekt
-1303	Validierung fehlgeschlagen, da die maximale Menge an Einlösungen für diesen Code erreicht ist	nur indirekt
-1302	Validierung fehlgeschlagen, da der Code nicht mehr gültig ist	nur indirekt
-1301	Validierung fehlgeschlagen, da der Code nicht existiert	nur indirekt
-655	Die VisitorID steht nicht mit der PersonID in Verbindung	nur indirekt
-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

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	Interne Änderung : Datentyp-Erweiterung des „ReferenceKey“ [für „_mi_StartProcedure“-Aufruf]
6.5.4	2013-04-29	Anpassungen an aktuellen Code-Standard, u.a. wg. UTF8-Unterstützung
6.5.0	2012-09-17	Hinweis in der Doku auf den neuen „Settings“-Eintrag „CampaignSurchargesEnabled“
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_ValidateVoucherCode_Pu im Engine Playground öffnen

cURL

Unformatierte Ausgabe:

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

Mit xmllint ⁵⁾ formatierte Ausgabe:

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