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-Method | POST |
HTTP-Auth | Optional |
Alias | om_ModifyVoucherTypeSurcharges_Ad |
Tags | |
Engine-Kategorie | configurations |
Engine-Typ | Daten-Änderung |
Letzte Aktualisierung | 7.0.7 (2015-01-29) |
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 ! | smallint | 6.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 ! | smallint | 6.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 | |
DeleteSurcharge | 0 | Existiert die Kombination „VoucherTypeID“-„SurchargeTypeID“ schon, entscheidet dieser Parameter, ob sie geändert („0“) oder gelöscht („1“) werden soll | bit | 6.0.2 |
Die Prozedur hat keine Rückgaben.
Die Prozedur hat keine Output-Parameter.
Code | Beschreibung | Quelle 4) |
---|---|---|
-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 | direkt und indirekt |
-500 | Falsche Parameter | direkt und indirekt |
Die Rückgabe erfolgt als XML-Dokument welches gegen das Schema Response/EngineProcedure_v1_0.xsd validiert.
7.0.7 | 2015-01-29 | Interne Änderung : Datentyp-Erweiterung des „ReferenceKey“ [für „_mi_StartProcedure“-Aufruf] |
6.5.1 | 2012-11-02 | Es 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-08 | Erstmalig in dieser Version erstellt |
Der folgende Link öffnet in einem separaten Fenster den Engine Playground der fest mit dem dbap-demo System verbunden ist:
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 -
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();
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>