Benutzer-Werkzeuge

Webseiten-Werkzeuge


engine:procedures:om_getcampordersurchdisc_ad

om_GetCampOrderSurchDisc_Ad

Gibt die „Rabatt auf Zusatzkosten“-Benefits einer Verkaufs-Aktion aus.

HTTP-MethodGET
HTTP-AuthOptional
Aliasom_GetCampaignOrderSurchargeDiscounts_Ad
Tags
Engine-Kategorieorder management
Engine-TypDaten-Ermittlung
Letzte Aktualisierung7.0.7 (2015-01-29)

Parameter

Name 1) Standard-Wert Beschreibung 2) SQL-Datentyp3) ab Version
CampaignID ID einer Verkaufs-Aktion. Falls angegeben, werden die zu dieser Aktion definierten „Rabatt auf Zusatzkosten“-Benefits ermittelt. „NULL“ für diesen Parameter UND für „BenefitID“ anzugeben ist nur im Fall „GetUnusedBenefits = 1“ erlaubt !
integer6.5.0
BenefitIDNULL ID eines „Rabatt auf Zusatzkosten“-Benefits. Wird nur beachtet, wenn „GetUnusedBenefits = 0“ UND „CampaignID = NULL“ ist. Falls angegeben, wird nur die Definition dieses Rabatts (der mehreren Verkaufs-Aktionen zugewiesen sein kann) ermittelt.
integer6.5.0
GetUnusedBenefits0 „1“ angeben, um an alle Rabatt-Benefits zu kommen, die noch gar keiner Verkaufs-Aktion zugeordnet wurden (durch om_ModifyCampOrderSurchDisc_Ad) - „CampaignID“ und „BenefitID“ werden dann nicht beachtet
bit6.5.0

Rückgabe

(parameterunabhängig)

Spaltenname Beschreibung SQL-Datentyp4) ab Version
BenefitIDID eines „Rabatt auf Zusatzkosten“-Benefits für Verkaufs-Aktionen - natürlich identisch mit „BenefitID“ wenn angegeben
integer6.5.0
ApplyToSurchargeTypeIDID eines „Surcharges“ (derzeit : der Kategorie „Versandkosten“ oder „Zahlungskosten“), auf den der durch „DiscountSurchargeTypeID“ und „DiscountValue“ bestimmte Rabatt gewährt wird
smallint6.5.0
ApplyToSurchargeDescriptionBezeichnung der „ApplyToSurchargeTypeID“
varchar(100)6.5.0
DiscountSurchargeTypeIDID eines „Surcharges“ der Kategorie „Relative Rabatte“
smallint6.5.0
DiscountSurchargeDescriptionBezeichnung der „DiscountSurchargeTypeID“
varchar(100)6.5.0
DiscountValueRelativer Rabatt (positiver Wert, aber „⇐ 100“), der auf die durch „ApplyToSurchargeTypeID“ anfallenden Kosten gewährt wird
decimal(16,6)6.5.0

Output-Parameter

Die Prozedur hat keine Output-Parameter.

Mögliche Return-Codes

Code Beschreibung Quelle 5)
-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 abgebrochennur 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.0 2012-09-17Erstmalig 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 GET  'http://<partner>-<project>.dstore.de/default/engine/om_GetCampOrderSurchDisc_Ad?CampaignID=<value>'

Mit xmllint 6) formatierte Ausgabe:

curl -X GET  'http://<partner>-<project>.dstore.de/default/engine/om_GetCampOrderSurchDisc_Ad?CampaignID=<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_GetCampOrderSurchDisc_Ad',
		array(
			'CampaignID' => <value>,
			// 'BenefitID' => NULL,
			// 'GetUnusedBenefits' => 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_GetCampOrderSurchDisc_Ad">
			<Parameters>
				<Parameter Name="CampaignID"><!-- integer value --></Parameter>
				<!-- <Parameter Name="BenefitID">NULL</Parameter> -->
				<!-- <Parameter Name="GetUnusedBenefits">0</Parameter> -->
			</Parameters>
		</Procedure>
	</Batch>
</ListOfBatches>
1)
Pflichtparameter sind unterstrichen
5)
direkt meint „von der Prozedur selber“ und indirekt meint „von intern aufgerufenen Unterprozeduren“
6)
I.d.R. auf Unix-artigen Systemen bereits installiert, Bestandteil der libxml2, siehe http://www.xmlsoft.org
engine/procedures/om_getcampordersurchdisc_ad.txt · Zuletzt geändert: 11.01.2016 (Externe Bearbeitung)