om_GetCampaignSettingEntry [dstore]

Inhaltsverzeichnis

om_GetCampaignSettingEntry

om_GetCampaignSettingEntry

Liefert den hinterlegten Wert aus „CampaignSettings“ zu einer Verkaufs-Aktion und einem bestimmten Schlüssel.

HTTP-Method	GET
HTTP-Auth	Optional
Tags	[om, Get, Campaign, Setting, Entry]
Engine-Kategorie	order management
Engine-Typ	Daten-Ermittlung
Letzte Aktualisierung	6.0.7 (2012-05-08)

Parameter

Name ¹⁾	Standard-Wert	Beschreibung ²⁾	SQL-Datentyp³⁾	ab Version
CampaignID		ID einer Verkaufs-Aktion	integer	6.0.7
KeyVariable		Ein Schlüssel (z.B. „MultipleDiscountsStrategy“), zu dem der hinterlegte Wert ausgegeben werden soll. Mögliche Werte : siehe Rückgabemenge von „ do_GetSettingsDescriptions_Ad 'CampaignSettings' “.	varchar(50)	6.0.7
SelectResult	0	„0“ : Der zum Schlüsel „KeyVariable“ hinterlegte Wert wird NUR über den Ausgabeparameter „SettingValue“ zurückgegeben „1“ : Es wird ZUSÄTZLICH eine Rückgabemenge bereitgestellt	bit	6.0.7
PrintErrorMsgIfEntryIsMissing	1	Falls KEIN Eintrag gefunden wird, gibt es immer einen Fehler. Gibt man hier „1“ an, wird in so einem Fall eine entsprechende Meldung via „print“ erzeugt (was die Fehler-Analyse erleichtert, wenn diese Prozedur innerhalb anderer aufgerufen wird).	bit	6.0.7

Rückgabe

wenn SelectResult = 1

Spaltenname	Beschreibung	SQL-Datentyp⁴⁾	ab Version
SettingValue		varchar(100)	6.0.7

Output-Parameter

SettingValue

Ausgabeparameter für den zum Schlüssel „KeyVariable“ hinterlegten Wert

Mögliche Return-Codes

Code	Beschreibung	Quelle ⁵⁾
-1204	Fehlender oder falscher Eintrag in CampaignSettings	nur direkt

XML-Schema

Die Rückgabe erfolgt als XML-Dokument welches gegen das Schema Response/EngineProcedure_v1_0.xsd validiert.

Historie

6.0.7

2012-05-08

Erstmalig 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:

om_GetCampaignSettingEntry im Engine Playground öffnen

cURL

Unformatierte Ausgabe:

curl -X GET  'http://<partner>-<project>.dstore.de/default/engine/om_GetCampaignSettingEntry?CampaignID=<value>&KeyVariable=<value>'

Mit xmllint ⁶⁾ formatierte Ausgabe:

curl -X GET  'http://<partner>-<project>.dstore.de/default/engine/om_GetCampaignSettingEntry?CampaignID=<value>&KeyVariable=<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_GetCampaignSettingEntry',
		array(
			'CampaignID' => <value>,
			'KeyVariable' => '<value>',
			// 'SelectResult' => 0,
			// 'PrintErrorMsgIfEntryIsMissing' => 1
		)
);
 
$service->execute($request);
 
			$xml_result = $request->getResponse()->getBody()->toSimpleXmlDocument();
			$ResultSet = $xml_result->getRowsAsArray();
 
$OutputParams = $xml_result->getOutputParametersAsArray();

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_GetCampaignSettingEntry">
			<Parameters>
				<Parameter Name="CampaignID"><!-- integer value --></Parameter>
				<Parameter Name="KeyVariable"><!-- varchar value --></Parameter>
				<!-- <Parameter Name="SelectResult">0</Parameter> -->
				<!-- <Parameter Name="PrintErrorMsgIfEntryIsMissing">1</Parameter> -->
			</Parameters>
		</Procedure>
	</Batch>
</ListOfBatches>

¹⁾

Pflichtparameter sind unterstrichen

²⁾

siehe Parameter-Konventionen engine/<Prozedur-Name>

³⁾ , ⁴⁾

siehe Datentypen im Bereich "engine"

⁵⁾

direkt meint „von der Prozedur selber“ und indirekt meint „von intern aufgerufenen Unterprozeduren“

⁶⁾

I.d.R. auf Unix-artigen Systemen bereits installiert, Bestandteil der libxml2, siehe http://www.xmlsoft.org

Benutzer-Werkzeuge

Webseiten-Werkzeuge

Inhaltsverzeichnis