Benutzer-Werkzeuge

Webseiten-Werkzeuge


engine:procedures:om_modifyvouchertypesurch_ad

om_ModifyVoucherTypeSurch_Ad

Erstellt, ändert und löscht die Konfiguration von zu Gutschein-Aktionen hinterlegten Rabatten (allgemein „Surcharges“, also auch prinzipiell Aufschläge, die aber bei Gutschein-Aktionen nicht erlaubt sind).

HTTP-MethodPOST
HTTP-AuthOptional
Aliasom_ModifyVoucherTypeSurcharges_Ad
Tags
Engine-Kategorieconfigurations
Engine-TypDaten-Änderung
Letzte Aktualisierung7.0.7 (2015-01-29)

Parameter

Name 1) Standard-Wert Beschreibung 2) SQL-Datentyp3) ab Version
VoucherTypeID ID einer Gutschein-Aktion. Gibt es noch keinen Datensatz für „SurchargeTypeID“ und „VoucherTypeID“, wird ein neuer „VoucherTypeSurcharge“ angelegt. Es muß zur Aktion „BenefitTypeID = 1“ (s. Rückgabe von om_GetVoucherTypes_Ad) konfiguriert sein !
smallint6.0.2
SurchargeTypeID ID einer Aufschlags-/Rabattart. Alle zur „VoucherTypeID“ konfigurierten „SurchargeTypeID“s müssen derselben Kategorie („SurchargeTypeCategoryID“) angehören, wobei es nur „Relative Rabatte“ (ID „1“) oder „Absolute Rabatte“ (ID „2“) sein darf !
smallint6.0.2
SurchargeValue Der eigentliche Rabatt-Wert (wie zu verstehen, also ob prozentual oder absolut, ist ja durch „SurchargeTypeID“ bestimmt). Er darf weder „NULL“ noch „>= 0“ sein, da bei Gutschein-Aktionen keine Aufschläge erlaubt sind !
decimal(16,6)6.0.2
DeleteSurcharge0 Existiert die Kombination „VoucherTypeID“-„SurchargeTypeID“ schon, entscheidet dieser Parameter, ob sie geändert („0“) oder gelöscht („1“) werden soll
bit6.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 4)
-569Der Benutzer hat kein Ausführungsrecht für die Prozedurnur indirekt
-567Die Prozedur darf z. Zt. nicht ausgeführt werdennur indirekt
-566Die Prozedur darf mit den übergebenen Parametern nicht ausgeführt werdennur indirekt
-535Das Datum liegt nicht in der Vergangenheitnur indirekt
-530Der Wert ist nicht konvertierbarnur indirekt
-510Der Benutzer ist nicht registriertnur indirekt
-504Es ist ein Problem aufgetreten, das nicht gelöst werden kann, Prozedur wird daher abgebrochendirekt und indirekt
-500Falsche Parameterdirekt 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-29Interne Änderung : Datentyp-Erweiterung des „ReferenceKey“ [für „_mi_StartProcedure“-Aufruf]
6.5.1 2012-11-02Es wird ab sofort geprüft, ob die „BenefitTypeID“ von „VoucherTypeID“ auch unterstützt wird. Derzeit wird nur
„BenefitTypeID=1“ [„SurchargeBenefit“] unterstützt.
6.0.2 2011-06-08Erstmalig 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:

cURL

Unformatierte Ausgabe:

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

Mit xmllint 5) formatierte Ausgabe:

curl -X POST  'http://<partner>-<project>.dstore.de/default/engine/om_ModifyVoucherTypeSurch_Ad?VoucherTypeID=<value>&SurchargeTypeID=<value>&SurchargeValue=<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_ModifyVoucherTypeSurch_Ad',
		array(
			'VoucherTypeID' => <value>,
			'SurchargeTypeID' => <value>,
			'SurchargeValue' => <value>,
			// 'DeleteSurcharge' => 0
		)
);
 
$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_ModifyVoucherTypeSurch_Ad">
			<Parameters>
				<Parameter Name="VoucherTypeID"><!-- smallint value --></Parameter>
				<Parameter Name="SurchargeTypeID"><!-- smallint value --></Parameter>
				<Parameter Name="SurchargeValue"><!-- decimal value --></Parameter>
				<!-- <Parameter Name="DeleteSurcharge">0</Parameter> -->
			</Parameters>
		</Procedure>
	</Batch>
</ListOfBatches>
1) Pflichtparameter sind unterstrichen
4) direkt meint „von der Prozedur selber“ und indirekt meint „von intern aufgerufenen Unterprozeduren“
5) I.d.R. auf Unix-artigen Systemen bereits installiert, Bestandteil der libxml2, siehe http://www.xmlsoft.org
engine/procedures/om_modifyvouchertypesurch_ad.txt · Zuletzt geändert: 11.01.2016 (Externe Bearbeitung)

Seiten-Werkzeuge