om_GetCurrentCampaigns [dstore]

Inhaltsverzeichnis

om_GetCurrentCampaigns

om_GetCurrentCampaigns

Ermittelt, welche Verkaufs-Aktionen (die sogenannten „Campaigns“) für den Benutzer, der diese Prozedur aufruft, zum aktuellen Zeitpunkt in Frage kommen.

Es gibt Aktionen, die als Bedingung eine bestimmte Zahlungs-und/oder Versandart erfordern bzw. ausschließen oder bei denen der Auftraggeber einer bestimmten (Personen-)Gruppe angehören muß. Sobald dem Aufrufer der Auftraggeber und/oder die Zahlungs-und/oder Versandart bekannt ist, sollte er/sie über „PersonID“ bzw. „PaymentTypeID“ bzw. „ShippingTypeID“ angegeben werden, weil sonst JEDE Aktion, die eine Personengruppen- bzw. Zahlungsart- bzw. Versandart-Bedingung besitzt, HERAUSgefiltert wird, genauer :

Ist „PersonID“ unbekannt, werden Aktionen mit einer Personengruppen-Bedingung auf jeden Fall NICHT beachtet
Ist „PaymentTypeID“ unbekannt, fliegen die Aktionen mit einer Zahlungsart-Bedingung garantiert heraus
Ist „ShippingTypeID“ unbekannt, scheiden die „Campaigns“ mit einer Versandart-Bedingung aus.

HTTP-Method	GET
HTTP-Auth	Optional
Tags	[om, Get, Current, Campaigns]
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
PersonID	NULL	ID einer Person, die voraussichtlich Auftraggeber sein wird (kann „NULL“ sein). Benötigt wird diese Information für Verkaufsaktionen mit Personengruppen-Bedingungen	integer	7.0.2
PaymentTypeID	NULL	ID einer Zahlungsart, mit der die Ware bezahlt werden soll (kann „NULL“ sein). Benötigt wird diese Information für Verkaufsaktionen mit Zahlungsart-Bedingungen.	smallint	7.0.2
ShippingTypeID	NULL	ID einer Versandart, mit der die Ware ausgeliefert werden soll (kann „NULL“ sein). Benötigt wird diese Information für Verkaufsaktionen mit Versandart-Bedingungen.	tinyint	7.0.2
GetBenefits	0	Bestimmt, ob die Rückgabemenge Informationen zu den „Benefits“ liefern soll („1“) oder nicht („0“).	bit	7.0.4

Rückgabe

wenn GetBenefits = 0

Spaltenname	Beschreibung	SQL-Datentyp⁴⁾	ab Version
CampaignID	ID einer Verkaufs-Aktion	integer	6.0.0
CampaignName	Bezeichnung der Verkaufs-Aktion „CampaignID“	varchar(100)	6.0.0
CampaignDescription	Beschreibung (kann Kommentar, Zeitraum etc. enthalten) der Verkaufs-Aktion „CampaignID“	varchar(255)	6.0.0

wenn GetBenefits = 1

Spaltenname	Beschreibung	SQL-Datentyp⁵⁾	ab Version
CampaignDescription	Beschreibung (kann Kommentar, Zeitraum etc. enthalten) der Verkaufs-Aktion „CampaignID“	varchar(255)	6.0.0
CampaignID	ID einer Verkaufs-Aktion	integer	6.0.0
CampaignName	Bezeichnung der Verkaufs-Aktion „CampaignID“	varchar(100)	6.0.0
BenefitID	ID eines Benefits vom Typ „BenefitTypeID“, der für die Aktion gewährt wird	integer	7.0.4
BenefitTypeID	Die ID der „Art von Benefit“ (z.B. Rabatt), von der „BenefitID“ ist	tinyint	7.0.4

Output-Parameter

Die Prozedur hat keine Output-Parameter.

Mögliche Return-Codes

Code	Beschreibung	Quelle ⁶⁾
-621	Fehlender oder falscher Eintrag in PersonTypeSettings	nur indirekt
-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
-550	Fehlender oder falscher Eintrag in Settings	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	„Start-/Finish-Procedure“-Logik eingebaut, s. Ticket #3670
7.0.4	2014-03-19	Neue Parameter „GetBenefits“ und im Fall „GetBenefits = 1“ Erweiterung der Ergebnismenge
7.0.2	2013-08-29	Neue Parameter „PersonID“, „PaymentTypeID“ und „ShippingTypeID“
6.5.0	2012-09-17	Komplette Neu-Codierung
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_GetCurrentCampaigns im Engine Playground öffnen

cURL

Unformatierte Ausgabe:

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

Mit xmllint ⁷⁾ formatierte Ausgabe:

curl -X GET  'http://<partner>-<project>.dstore.de/default/engine/om_GetCurrentCampaigns' | 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_GetCurrentCampaigns',
		array(
			// 'PersonID' => NULL,
			// 'PaymentTypeID' => NULL,
			// 'ShippingTypeID' => NULL,
			// 'GetBenefits' => 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_GetCurrentCampaigns">
			<Parameters>
				<!-- <Parameter Name="PersonID">NULL</Parameter> -->
				<!-- <Parameter Name="PaymentTypeID">NULL</Parameter> -->
				<!-- <Parameter Name="ShippingTypeID">NULL</Parameter> -->
				<!-- <Parameter Name="GetBenefits">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