om_GetCampaignsInCategories_Ad [dstore]

Inhaltsverzeichnis

om_GetCampaignsInCategories_Ad

om_GetCampaignsInCategories_Ad

Gibt die Verkaufsaktionen in ihren Kategorien zurück.

HTTP-Method	GET
HTTP-Auth	Optional
Tags	[om, Get, Campaigns, In, Categories, Ad]
Engine-Kategorie	order management
Engine-Typ	Daten-Ermittlung
Letzte Aktualisierung	7.0.7 (2015-01-29)

Parameter

Name ¹⁾	Standard-Wert	Beschreibung ²⁾	SQL-Datentyp³⁾	ab Version
CampaignCategoryID	NULL	Wenn angegeben, werden nur die Verkaufsaktionen zurück gegeben, die „CampaignCategoryID“ zugewiesen wurden.	smallint	7.0.5
CampaignID	NULL	Wenn angegeben, werden alle Kategorien zurück gegeben, in die „CampaignID“ eingeordnet wurde.	integer	7.0.5

Rückgabe

(parameterunabhängig)

Spaltenname	Beschreibung	SQL-Datentyp⁴⁾	ab Version
CampaignCategoryID	Kategorie, in die „CampaignID“ eingeordnet ist	smallint	7.0.5
CategoryDescription	Beschreibung der Kategoire „CampaignCategoryID“	varchar(100)	7.0.5
CampaignID	Die ID einer Verkaufsaktion	integer	7.0.5
CampaignName	Der Name der Verkaufsaktion zur „CampaignID“	varchar(100)	7.0.5
CampaignDescription	Die Beschreibung der Verkaufsaktion zu „CampaignID“	varchar(255)	7.0.5
CampaignTypeID	Die ID des Typs zur „CampaignID“	tinyint	7.0.5
CampaignType	Der Name der „CampaignTypeID“	varchar(100)	7.0.5
Active	„0“, wenn „CampaignID“ inaktiv ist, „1“, wenn „CampaignID“ aktiv ist.	tinyint	7.0.5
SortNo	Die Anzeigereihenfolge der Zuordnung von „CampaignID“ zur „CampaignCategoryID“	tinyint	7.0.5

Sortierung der Rückgabe

(parameterunabängige Sortierung)

CampaignCategoryID (aufsteigend)
SortNo (aufsteigend)

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]
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_GetCampaignsInCategories_Ad im Engine Playground öffnen

cURL

Unformatierte Ausgabe:

curl -X GET  'http://<partner>-<project>.dstore.de/default/engine/om_GetCampaignsInCategories_Ad'

Mit xmllint ⁶⁾ formatierte Ausgabe:

curl -X GET  'http://<partner>-<project>.dstore.de/default/engine/om_GetCampaignsInCategories_Ad' | 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_GetCampaignsInCategories_Ad',
		array(
			// 'CampaignCategoryID' => NULL,
			// 'CampaignID' => NULL
		)
);
 
$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_GetCampaignsInCategories_Ad">
			<Parameters>
				<!-- <Parameter Name="CampaignCategoryID">NULL</Parameter> -->
				<!-- <Parameter Name="CampaignID">NULL</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