Benutzer-Werkzeuge

Webseiten-Werkzeuge


engine:procedures:om_getcampaignbenefits_ad

om_GetCampaignBenefits_Ad

Liefert die Benefit(s), die ein Auftraggeber erhält, wenn er einen Auftrag platziert, der die Bedingungen einer Verkaufsaktion („CampaignID“) erfüllt.

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 der Verkaufs-Aktion, zu der die definierten „Benefits“ ermittelt werden sollen
integer6.0.8
BenefitTypeIDNULL ID eines „BenefitTypes“ (mögliche Werte : s. om_GetBenefitTypes_Ad). Falls angegeben, wird nur der entspr. Datensatz ermittelt. Hintergrund : es ist möglich, daß einer Verkaufsaktion mehrere „Benefits“ zugeordnet werden, aber nur einer pro „BenefitType“.
tinyint6.0.8

Rückgabe

(parameterunabhängig)

Spaltenname Beschreibung SQL-Datentyp4) ab Version
CampaignIDDie ID einer Verkaufsaktion (derzeit immer identisch mit „CampaignID“)
integer6.0.8
BenefitIDDie ID eines „Benefits“ vom Typ „BenefitTypeID“, das zur Aktion „CampaignID“ konfiguriert ist
integer6.0.8
BenefitTypeIDDie ID der „Art von Benefit“ (z.B. Rabatt), von der „BenefitID“ ist
tinyint6.0.8
BenefitTypeDescriptionDie Bezeichnung der „BenefitTypeID“
varchar(100)6.0.8

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.0.8 2012-06-29Erstmalig 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_GetCampaignBenefits_Ad?CampaignID=<value>'

Mit xmllint 6) formatierte Ausgabe:

curl -X GET  'http://<partner>-<project>.dstore.de/default/engine/om_GetCampaignBenefits_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_GetCampaignBenefits_Ad',
		array(
			'CampaignID' => <value>,
			// 'BenefitTypeID' => NULL
		)
);
 
$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_GetCampaignBenefits_Ad">
			<Parameters>
				<Parameter Name="CampaignID"><!-- integer value --></Parameter>
				<!-- <Parameter Name="BenefitTypeID">NULL</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_getcampaignbenefits_ad.txt · Zuletzt geändert: 11.01.2016 (Externe Bearbeitung)