om_ModifyCampaignTypes_Ad [dstore]

Inhaltsverzeichnis

om_ModifyCampaignTypes_Ad

om_ModifyCampaignTypes_Ad

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

Typen sind dazu da, den Benutzer-Kreis zu definieren - wie z.B. „nur Webshop“ - für den Aktionen (des entsprechenden Typs) nutzbar sind (s. om_GetCampaignTypeRules_Ad).

HTTP-Method	POST
HTTP-Auth	Optional
Tags	[om, Modify, Campaign, Types, 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	NULL	ID eines „Typs“ von „Campaigns“. „NULL“ angeben, um einen neuen Typ anzulegen. Sonst wird ein bestehender Typ je nach „DeleteCampaignType“ geändert oder gelöscht.	tinyint	6.0.0
CampaignType		Bezeichnung des Typs „CampaignTypeID“	varchar(100)	6.0.0
DeleteCampaignType	0	Wird nur beachtet, wenn „CampaignTypeID“ angegeben ist ! Entscheidet, ob der bestehende Typ geändert („0“) oder gelöscht („1“) wird. Löschen kann man einen Typ logischerweise nur, wenn er noch nicht verwendet 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
-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]
6.5.4	2013-04-29	Anpassungen an aktuellen Code-Standard, u.a. wg. UTF8-Unterstützung
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_ModifyCampaignTypes_Ad im Engine Playground öffnen

cURL

Unformatierte Ausgabe:

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

Mit xmllint ⁵⁾ formatierte Ausgabe:

curl -X POST  'http://<partner>-<project>.dstore.de/default/engine/om_ModifyCampaignTypes_Ad?CampaignType=<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_ModifyCampaignTypes_Ad',
		array(
			'CampaignType' => '<value>',
			// 'CampaignTypeID' => NULL,
			// 'DeleteCampaignType' => 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_ModifyCampaignTypes_Ad">
			<Parameters>
				<Parameter Name="CampaignType"><!-- varchar value --></Parameter>
				<!-- <Parameter Name="CampaignTypeID">NULL</Parameter> -->
				<!-- <Parameter Name="DeleteCampaignType">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