om_CreateVoucherCodes_Ad [dstore]

Inhaltsverzeichnis

om_CreateVoucherCodes_Ad

om_CreateVoucherCodes_Ad

Erzeugt einen oder mehrere Gutschein-Codes für eine Gutschein-Aktion.

HTTP-Method	POST
HTTP-Auth	Optional
Tags	[om, Create, Voucher, Codes, Ad]
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
VoucherTypeID		ID einer Gutschein-Aktion, zu der Codes generiert werden sollen. Mögliche Werte : s. om_GetVoucherTypes_Ad.	smallint	6.0.2
NumberOfCodes		Wieviele Codes generiert werden sollen. Bei Angabe von „NULL“ wird (wie auch beim Wert „1“) genau ein Code generiert.	integer	6.0.2
ValidUntil	NULL	Jeder der neuen Codes ist bis zu diesem Zeitpunkt gültig. Bei Angabe von „NULL“ bestimmt die „DefaultValidUntil“- bzw. ValidForXDays„-Einstellung der Aktion „VoucherTypeID“ diesen Zeitpunkt. Pflicht-Angabe, falls keine der Einstellungen konfiguriert ist.	datetime	6.0.2

Rückgabe

Die Prozedur hat keine Rückgaben.

Output-Parameter

NewVoucherCode	Sofern genau ein neuer Code erzeugt werden soll, steht dieser neue Code nach dem Aufruf in diesem Parameter zur Verfügung (sonst steht hier nach der Ausführung „NULL“)
CreationDate	Ausgabeparameter, der mit dem Zeitpunkt der Erzeugung der neuen Codes belegt wird, um diesen beim Aufruf von om_GetVoucherCodes_Ad für „FromCreationDate“ und „ToCreationDate“ angeben zu können, um alle soeben erzeugten Codes zu erhalten.

Mögliche Return-Codes

Code	Beschreibung	Quelle ⁴⁾
-1306	Es können keine Codes für die Gutschein-Aktion (mehr) generiert werden	nur 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	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	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.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_CreateVoucherCodes_Ad im Engine Playground öffnen

cURL

Unformatierte Ausgabe:

curl -X POST  'http://<partner>-<project>.dstore.de/default/engine/om_CreateVoucherCodes_Ad?VoucherTypeID=<value>&NumberOfCodes=<value>'

Mit xmllint ⁵⁾ formatierte Ausgabe:

curl -X POST  'http://<partner>-<project>.dstore.de/default/engine/om_CreateVoucherCodes_Ad?VoucherTypeID=<value>&NumberOfCodes=<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_CreateVoucherCodes_Ad',
		array(
			'VoucherTypeID' => <value>,
			'NumberOfCodes' => <value>,
			// 'ValidUntil' => NULL
		)
);
 
$service->execute($request);
 
			$xml_result = $request->getResponse()->getBody()->toSimpleXmlDocument();
			$ResultSet = $xml_result->getRowsAsArray();
 
$OutputParams = $xml_result->getOutputParametersAsArray();

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_CreateVoucherCodes_Ad">
			<Parameters>
				<Parameter Name="VoucherTypeID"><!-- smallint value --></Parameter>
				<Parameter Name="NumberOfCodes"><!-- integer value --></Parameter>
				<!-- <Parameter Name="ValidUntil">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