om_ModifyCampaignTypeRules_Ad [dstore]

Inhaltsverzeichnis

om_ModifyCampaignTypeRules_Ad

om_ModifyCampaignTypeRules_Ad

Verwaltet die konfigurierten Regeln hinsichtlich „Typen“ von Verkaufs-Aktionen (die sogenannten „Campaigns“).

Diese Regeln bestimmen, für welche „dStore-Benutzer“ („UserID“s aus „UserInfo“) eine Verkaufs-Aktion des jeweiligen Typs überhaupt gültig ist.

Hinweis zur Reihenfolge der Beachtung dieser Regeln :

1. Regeln zu einer gegebenen „UserID“ werden immer „globalen“ Regeln („UserID = -1“) vorgezogen.

2. Ist für eine „Benutzer-Aktionstyp-Kombination“ (also zu einer gegebenen „UserID“ und „CampaignTypeID“) KEINE passende Regel vorhanden, bedeutet dies implizit, daß der Benutzer Verkaufs-Aktionen dieses Typs NICHT nutzen kann !
Anders formuliert : Keine passende Regel ist gleichbedeutend mit einer passenden Regel, bei der „Allowed = 0“ ist !

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

Parameter

Name ¹⁾	Standard-Wert	Beschreibung ²⁾	SQL-Datentyp³⁾	ab Version
CampaignTypeID		ID eines „Typs“ von „Campaigns“	tinyint	6.0.0
UserID		ID eines „dStore“-Benutzers, der in „UserInfo“ registriert ist (siehe mi_GetUserInfo_Ad), für den eine neue Regel angelegt, geändert oder gelöscht werden soll. Wird „-1“ angegeben, gilt die Regel für alle Benutzer.	smallint	6.0.0
Allowed		Gibt an, ob Aktionen des Typs „CampaignTypeID“ vom Benutzer „UserID“ verwendet werden können („1“) oder nicht („0“).	bit	6.0.0
DeleteRule	0	Wird nur beachtet, wenn es schon eine Regel zur „CampaignTypeID“-„UserID“-Kombination gibt ! Entscheidet, ob die Regel gelöscht („0“) oder der „Allowed“-Wert geändert („1“) wird.	bit	6.0.0

Rückgabe

Die Prozedur hat keine Rückgaben.

Output-Parameter

Die Prozedur hat keine Output-Parameter.

Mögliche Return-Codes

Code	Beschreibung	Quelle ⁴⁾
-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
-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
-500	Falsche Parameter	nur 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]
6.0.0	2010-03-26	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_ModifyCampaignTypeRules_Ad im Engine Playground öffnen

cURL

Unformatierte Ausgabe:

curl -X POST  'http://<partner>-<project>.dstore.de/default/engine/om_ModifyCampaignTypeRules_Ad?CampaignTypeID=<value>&UserID=<value>&Allowed=<value>'

Mit xmllint ⁵⁾ formatierte Ausgabe:

curl -X POST  'http://<partner>-<project>.dstore.de/default/engine/om_ModifyCampaignTypeRules_Ad?CampaignTypeID=<value>&UserID=<value>&Allowed=<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_ModifyCampaignTypeRules_Ad',
		array(
			'CampaignTypeID' => <value>,
			'UserID' => <value>,
			'Allowed' => <value>,
			// 'DeleteRule' => 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_ModifyCampaignTypeRules_Ad">
			<Parameters>
				<Parameter Name="CampaignTypeID"><!-- tinyint value --></Parameter>
				<Parameter Name="UserID"><!-- smallint value --></Parameter>
				<Parameter Name="Allowed"><!-- bit value --></Parameter>
				<!-- <Parameter Name="DeleteRule">0</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