Erstellt, ändert oder löscht Gutschein-Aktionen, die sogenannten „VoucherTypes“. Darunter sind Aktionen zu verstehen, zu denen Codes generiert und an Kunden weitergegeben werden können, damit diese dann bei Einlösung einen Bonus erhalten, wie z.B. einen Auftragsrabatt oder einen Bonus-Artikel etc.

Anmerkung zum Parameter „GenerationPattern“ :

In „GenerationPattern“ gibt man an, wie ein Code zu einem „VoucherType“ auszusehen hat. Ist „VCodeOriginTypeID = 3“ (für
„Importiert“), wird „GenerationPattern“ ignoriert (wie „NULL“ behandelt).
In allen anderen Fällen muß hier entweder eine feste Zeichenkette angegeben werden oder die „randomstr“-Funktion für eine zufällige Teilzeichenkette (gebildet aus folgendem Zeichenvorrat : 0,..,9,a,..,z - Codes sind also insbesondere immer „lowercase“).
In letzterm Fall muß „GenerationPattern“ wie folgt aussehen : #randomstr(<strlength>,<opt.Prefix>,<opt.Postfix>)#
Das „randomstr-Pattern“ führt zu einer Erzeugung eines Codes, bestehend aus einer zufällig erzeugten Zeichenkette der Länge „strlength“, der optional ein „Prefix“ (feste Zeichenkette) VORANgestellt und optional ein „Postfix“ (feste Zeichenkette)
ANGEHÄNGT ist.
Gibt man für „GenerationPattern“ z.B. den Wert „ #randomstr(4,'te_','_st')# “ an, kann „te_sf8u_st“ als Code erzeugt werden.
ACHTUNG : Der optionale Prefix bzw. Postfix MUSS mit dem einfachen Anführungszeichen beginnen und enden und außerdem dürfen keine Leerzeichen zwischen den „Parametern“ der Funktion sein.

Weitere Beispiele für „GenerationPattern“ mit einer Erläuterung :

GenerationPattern | Hinweis/Bedeutung | Beispiel-Code
——————————–|——————————————————|—————-
#randomstr(8)# | Zufällige Zeichenkette aus 8 Zeichen | ae8im23pwy
Turbo3000 | Es gibt genau einen (festen) Code | turbo3000
#randomstr(8,bla)# | UNGÜLTIG, da „bla“ NICHT von ' eingeschlossen ist ! | -
#randomstr(6,,'bla')# | Zufällige Zeichenkette aus 6 Zeichen, gefolgt von | 2uver0bla
| der festen Zeichenkette „bla“ |
#randomstr(10, 'B','U')# | UNGÜLTIG, da eine Leertaste vor dem Postfix 'B' ist | -
#randomstr(1,'B','U')# | Zeichen 'b' (lower !), gefolgt von EINEM zufälligen | b5u
| Zeichen, abgeschlossen mit dem Zeichen 'u' (lower !) |

Anmerkungen zu den Parametern „DefaultValidUntil“ und „ValidForXDays“ :

1.) Wird weder „ValidForXDays“ noch „DefaultValidUntil“ angegeben, wird bei der Generierung von Codes (durch om_CreateVoucherCodes_Ad) zur Aktion erwartet, daß der Zeitpunkt des Ablaufs der Codes angegeben wird.
2.) Wird die „DefaultValidUntil“- oder „ValidForXDays“-Einstellung einer Gutschein-Aktion bearbeitet, gelten diese Änderungen nur für die zukünftige Erzeugung von Gutschein-Codes dieses Typs, nicht aber für bereits erzeugte Gutscheincodes !

Die Prozedur hat keine Rückgaben.

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

Der folgende Link öffnet in einem separaten Fenster den Engine Playground der fest mit dem dbap-demo System verbunden ist:

• om_ModifyVoucherTypes_Ad im Engine Playground öffnen

Unformatierte Ausgabe:

curl -X POST  'http://<partner>-<project>.dstore.de/default/engine/om_ModifyVoucherTypes_Ad?Description=<value>&VCodeOriginTypeID=<value>&GenerationPattern=<value>&BenefitTypeID=<value>'

Mit xmllint ²⁾ formatierte Ausgabe:

curl -X POST  'http://<partner>-<project>.dstore.de/default/engine/om_ModifyVoucherTypes_Ad?Description=<value>&VCodeOriginTypeID=<value>&GenerationPattern=<value>&BenefitTypeID=<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_ModifyVoucherTypes_Ad',
		array(
			'Description' => '<value>',
			'VCodeOriginTypeID' => <value>,
			'GenerationPattern' => '<value>',
			'BenefitTypeID' => <value>,
			// 'ValidForXDays' => NULL,
			// 'DefaultValidUntil' => NULL,
			// 'CodeStatus' => 0,
			// 'XTimesUsable' => NULL,
			// 'XTimesUsablePerPerson' => 1,
			// 'DeleteVoucherType' => 0
		)
);
 
$service->execute($request);
 
			$xml_result = $request->getResponse()->getBody()->toSimpleXmlDocument();
			$ResultSet = $xml_result->getRowsAsArray();
 
$OutputParams = $xml_result->getOutputParametersAsArray();

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_ModifyVoucherTypes_Ad">
			<Parameters>
				<Parameter Name="Description"><!-- varchar value --></Parameter>
				<Parameter Name="VCodeOriginTypeID"><!-- tinyint value --></Parameter>
				<Parameter Name="GenerationPattern"><!-- varchar value --></Parameter>
				<Parameter Name="BenefitTypeID"><!-- tinyint value --></Parameter>
				<!-- <Parameter Name="ValidForXDays">NULL</Parameter> -->
				<!-- <Parameter Name="DefaultValidUntil">NULL</Parameter> -->
				<!-- <Parameter Name="CodeStatus">0</Parameter> -->
				<!-- <Parameter Name="XTimesUsable">NULL</Parameter> -->
				<!-- <Parameter Name="XTimesUsablePerPerson">1</Parameter> -->
				<!-- <Parameter Name="DeleteVoucherType">0</Parameter> -->
			</Parameters>
		</Procedure>
	</Batch>
</ListOfBatches>