om_ModifyCampsInCategories_Ad [dstore]

Inhaltsverzeichnis

om_ModifyCampsInCategories_Ad

om_ModifyCampsInCategories_Ad

Prozedur zum Anlegen, Bearbeiten und Löschen von Zuordnungen von Verkaufsaktionen in Kategorien.

Anmerkungen zur „SortNo“ :
1:
Mit der „SortNo“ steuert man die Reihenfolge der einer Kategorie zugeordneten Verkaufsaktionen. Die Werte beginnen bei „1“ und sind lückenlos aufsteigend (je niedriger der Wert desto höher die Priorität). Und weil der Datentyp „tinyint“ ist, können „CampaignCategoryID“ somit maximal 255 Verkaufsaktionen zugeordnet werden

2:
Bei Neu-Anlage einer Zuordnung beachten wir „SortNo“ NICHT sondern vergeben automatisch den nächst größeren Wert.

3:
Bei einer Änderung (existiert die Zuordnung und ist „Delete = 0“) MUSS „SortNo“ auf jeden Fall angegeben werden und muß zwischen „1“ und der maximalen „SortNo“ einer bestehenden Zuordung liegen. In diesem Fall sorgen wir übrigens automatisch dafür, daß nach der Änderung die „SortNo“s aller Zuordnungen garantiert wieder lückenlos aufsteigend (bei „1“ beginnend) sind.

4:
Im Löschen-Fall erniedrigen wir die „SortNo“ anderer Zuordnungen mit einem Wert „> SortNo“ um „1“.

HTTP-Method	POST
HTTP-Auth	Optional
Alias	om_ModifyCampaignsInCategories_Ad
Tags	[Modify, Campaigns, In, Categories, 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
CampaignID		ID einer Verkaufs-Aktion deren Zuordnung zu „CampaignCategoryID“ erstellt/bearbeitet/gelöscht werden soll.	integer	7.0.5
CampaignCategoryID		ID einer Kategorie der „CampaignID“ zugeordnet werden soll bzw. dessen Zuordnung von „CampaignID“ gelöscht oder bearbeitet werden soll.	smallint	7.0.5
SortNo		Bestimmt die Reihenfolge von „CampaignID“ innerhalb aller „CampaignCategoryID“ zugeordneter Verkaufsaktionen. Wird nur beachtet, wenn die Zuordnung „CampaignID“ zu „CampaignCategoryID“ existiert - und ist in diesem Fall auch Pflicht (s. Beschreibung).	tinyint	7.0.5
Delete	0	„0“ : Die Zuordnung soll erstellt/bearbeitet werden „1“ : Die Zuordnung soll gelsöcht werden	bit	7.0.5

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	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.5	2014-05-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_ModifyCampsInCategories_Ad im Engine Playground öffnen

cURL

Unformatierte Ausgabe:

curl -X POST  'http://<partner>-<project>.dstore.de/default/engine/om_ModifyCampsInCategories_Ad?CampaignID=<value>&CampaignCategoryID=<value>&SortNo=<value>'

Mit xmllint ⁵⁾ formatierte Ausgabe:

curl -X POST  'http://<partner>-<project>.dstore.de/default/engine/om_ModifyCampsInCategories_Ad?CampaignID=<value>&CampaignCategoryID=<value>&SortNo=<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_ModifyCampsInCategories_Ad',
		array(
			'CampaignID' => <value>,
			'CampaignCategoryID' => <value>,
			'SortNo' => <value>,
			// 'Delete' => 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_ModifyCampsInCategories_Ad">
			<Parameters>
				<Parameter Name="CampaignID"><!-- integer value --></Parameter>
				<Parameter Name="CampaignCategoryID"><!-- smallint value --></Parameter>
				<Parameter Name="SortNo"><!-- tinyint value --></Parameter>
				<!-- <Parameter Name="Delete">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