Benutzer-Werkzeuge

Webseiten-Werkzeuge


engine:procedures:om_getcampaignbonusitems_ad

om_GetCampaignBonusItems_Ad

Gibt die Definition von Bonus-Item-Benefits zurück.

Hintergrund :
Der Benefit-Typ „Bonus-Artikel“ für Verkaufs-Aktionen bietet die Möglichkeit, sogenannte Sets von Artikeln definieren zu können, aus denen der Kunde sich ein oder mehrere Artikel aussuchen darf, die er kostenlos erhält - sofern die zur Verkaufs-Aktion definierten Bedingungen erfüllt sind.

HTTP-MethodGET
HTTP-AuthOptional
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, zu der die Bonus-Artikel-Definitionen ausgegeben werden sollen
integer7.0.4
BenefitIDNULL ID eines Bonus-Items-Benefits, dessen Definition ausgegeben werden soll. Wird nur beachtet, wenn „CampaignID = NULL“ ist.
integer7.0.4
GetAssignedSets1 Gibt an, ob in der Rückgabemenge auch die zugeordneten Sets ermittelt werden sollen („1“ - wenn gar keine Sets zugeordnet sind, ist das Ergebnis leer !) oder nicht („0“).
bit7.0.5

Rückgabe

wenn GetAssignedSets = 0

Spaltenname Beschreibung SQL-Datentyp4) ab Version
BenefitIDID eines Bonus-Item-Benefits für Verkaufs-Aktionen - natürlich identisch mit „BenefitID“ wenn angegeben
integer7.0.5
BonusFromOneSetOnlyGibt an, ob Bonus-Artikel nur aus einem Set gewählt werden dürfen („1“) oder aus jedem einzelnen Set („0“)
bit7.0.5

wenn GetAssignedSets = 1

Spaltenname Beschreibung SQL-Datentyp5) ab Version
BenefitIDID eines Bonus-Item-Benefits für Verkaufs-Aktionen - natürlich identisch mit „BenefitID“ wenn angegeben
integer7.0.4
BonusFromOneSetOnlyGibt an, ob Bonus-Artikel nur aus einem Set gewählt werden dürfen („1“) oder aus jedem einzelnen Set („0“)
bit7.0.4
ItemSetIDID eines Bonus-Sets, das Teil des Benefits „BenefitID“ ist
integer7.0.4
SortNoBestimmt die Reihenfolge von „ItemSetID“ innerhalb aller „BenefitID“ zugeordneten Sets
tinyint7.0.4
MaxQuantityGibt an, wieviele unterschiedliche Bonus-Artikel aus dem Set „ItemSetID“ gewählt werden dürfen
tinyint7.0.4
ItemConditionIDID der Artikel-Bedingung, die das Set „ItemSetID“ definiert. Die genaue Definition der Bedingung erhält man durch im_GetItemConditions_Ad.
integer7.0.4
ItemConditionDescriptionBezeichnung der Artikel-Bedingung „ItemConditionID“
varchar(255)7.0.4
Sortierung der Rückgabe

(parameterunabängige Sortierung)

  • SortNo (aufsteigend)

Output-Parameter

Die Prozedur hat keine Output-Parameter.

Mögliche Return-Codes

Code Beschreibung Quelle 6)
-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]
7.0.5 2014-05-261. Neuer Parameter „GetAssignedSets“
2. Fehler : Rückgabespalte „MaxQuantity“ wurde als „SetMaxQuantity“ und „ItemCondition…“ als „SetCondition…“ zurückgegeben
3. Kleine Performance-Verbesserung
7.0.4 2014-03-19Erstmalig 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_GetCampaignBonusItems_Ad?CampaignID=<value>'

Mit xmllint 7) formatierte Ausgabe:

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