engine:procedures:om_modifycampaigncategories

Inhaltsverzeichnis

om_ModifyCampaignCategories_Ad

om_ModifyCampaignCategories_Ad

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

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

Parameter

CategoryDescription		Bezeichnung der Kategorie	varchar(100)	7.0.5
Delete	0	„0“ : Es soll eine neue Kategorie angelegt werden bzw. die vorhandene Kategorie „CampaignCategoryID“ ist zu ändern „1“ : Die Kategorie „CampaignCategoryID“ soll gelöscht werden	bit	7.0.5

Rückgabe

Die Prozedur hat keine Rückgaben.

Output-Parameter

CampaignCategoryID

ID der Kategorie, die bearbeitet („Delete = 0“) oder gelöscht („Delete = 1“) werden soll.

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
-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.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_ModifyCampaignCategories_Ad im Engine Playground öffnen

cURL

Unformatierte Ausgabe:

curl -X POST  'http://<partner>-<project>.dstore.de/default/engine/om_ModifyCampaignCategories_Ad?CategoryDescription=<value>'

Mit xmllint ²⁾ formatierte Ausgabe:

curl -X POST  'http://<partner>-<project>.dstore.de/default/engine/om_ModifyCampaignCategories_Ad?CategoryDescription=<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_ModifyCampaignCategories_Ad',
		array(
			'CategoryDescription' => '<value>',
			// 'Delete' => 0
		)
);
 
$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_ModifyCampaignCategories_Ad">
			<Parameters>
				<Parameter Name="CategoryDescription"><!-- varchar value --></Parameter>
				<!-- <Parameter Name="Delete">0</Parameter> -->
			</Parameters>
		</Procedure>
	</Batch>
</ListOfBatches>

¹⁾

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