om_ModifyCampaignSettings_Ad [dstore]

Inhaltsverzeichnis

om_ModifyCampaignSettings_Ad

om_ModifyCampaignSettings_Ad

Prozedur zur Verwaltung von Einstellungen zu einer Verkaufs-Aktion.

ACHTUNG : Wenn die Verkaufs-Aktion aktiv ist (s. Rückgabespalte „Active“ von om_GetCampaigns_Ad), kann nichts mehr geändert werden !

HTTP-Method	POST
HTTP-Auth	Optional
Tags	[om, Modify, Campaign, Settings, Ad]
Engine-Kategorie	order management
Engine-Typ	Daten-Änderung
Letzte Aktualisierung	7.0.7 (2015-01-29)

Parameter

Name ¹⁾	Beschreibung ²⁾	SQL-Datentyp³⁾	ab Version
CampaignID	ID einer Verkaufs-Aktion	integer	6.0.8
KeyVariable	Ein Schlüssel (z.B. „CurrencyID“), zu dem der (zu „CampaignID“) hinterlegte Wert konfiguriert werden soll. Mögliche Werte : siehe Rückgabemenge von „ do_GetSettingsDescriptions_Ad 'CampaignSettings' “.	varchar(50)	6.0.8
Value	Wert, der zum Schlüssel „KeyVariable“ zur Verkaufs-Aktion „CampaignID“ gesetzt werden soll. „NULL“ bedeutet, daß der Wert gelöscht werden soll.	varchar(100)	6.0.8

Rückgabe

Die Prozedur hat keine Rückgaben.

Output-Parameter

Die Prozedur hat keine Output-Parameter.

Mögliche Return-Codes

Code	Beschreibung	Quelle ⁴⁾
-1252	Der Eintrag darf nicht mehr geändert/gelöscht werden	nur direkt
-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
-540	Falsches Format	nur direkt
-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	nur indirekt
-502	Die Parameter-Werte der Prozedur können nicht verarbeitet werden (kein passendes Trennzeichen)	nur indirekt
-500	Falsche Parameter	direkt 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-29	Interne Änderung : Datentyp-Erweiterung des „ReferenceKey“ [für „_mi_StartProcedure“-Aufruf]
7.0.6	2014-06-23	Interne Anpassungen zwecks Sonderbehandlung des neuen Eintrags zum Schlüssel „AbsDiscountSurchargeTypeIDForBundles“
6.5.4	2013-04-29	Anpassungen an aktuellen Code-Standard, u.a. wg. UTF8-Unterstützung
6.0.8	2012-06-29	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_ModifyCampaignSettings_Ad im Engine Playground öffnen

cURL

Unformatierte Ausgabe:

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

Mit xmllint ⁵⁾ formatierte Ausgabe:

curl -X POST  'http://<partner>-<project>.dstore.de/default/engine/om_ModifyCampaignSettings_Ad?CampaignID=<value>&KeyVariable=<value>&Value=<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_ModifyCampaignSettings_Ad',
		array(
			'CampaignID' => <value>,
			'KeyVariable' => '<value>',
			'Value' => '<value>'
		)
);
 
$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_ModifyCampaignSettings_Ad">
			<Parameters>
				<Parameter Name="CampaignID"><!-- integer value --></Parameter>
				<Parameter Name="KeyVariable"><!-- varchar value --></Parameter>
				<Parameter Name="Value"><!-- varchar value --></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