om_CheckCampCondsForTNIDs_Ad [dstore]

Inhaltsverzeichnis

om_CheckCampCondsForTNIDs_Ad

om_CheckCampCondsForTNIDs_Ad

Überprüft für einen gegebenen „virtuellen Warenkorb“, ob er die Bedingungen einer gegebenen Verkaufs-Aktion erfüllt.

HTTP-Method	POST
HTTP-Auth	Optional
Alias	om_CheckCampaignConditionsForTreeNodeIDs_Ad
Tags	[om, Check, Campaign, Conditions, For, Tree, Node, Ds, 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
TreeNodeIDList		Eine Liste von IDs (durch „,“ getrennt) von Elementen im Artikelbaum („TreeNodeID“s), die die Artikel im „virtuellen Warenkorb“ darstellen, für den geprüft werden soll, ob er die Bedingungen der durch „CampaignID“ angegebenen Verkaufs-Aktion erfüllt	varchar(16384)	6.0.7
CampaignID		ID einer Verkaufs-Aktion, für die geprüft werden soll, ob ihre Bedingungen vom durch „TreeNodeIDList“ und „QuantityList“ gegebenen virtuellen Warenkorb erfüllt werden	integer	6.0.7
QuantityList	NULL	Bei „NULL“ wird für jeden in „TreeNodeIDList“ gegebenen Artikel des „virtuellen Warenkorbes“ die Bestellmenge „1“ gewählt. Sonst ist (für jedes „korrespondierende Element“ in „TreeNodeIDList“) eine Liste von Bestellmengen (durch „,“ getrennt) anzugeben.	varchar(16384)	6.0.7
PersonID	NULL	ID des (potenziellen) Auftraggebers. „NULL“ angeben, falls (noch) nicht bekannt - wenn Personen-Bedingungen zur Verkaufs-Aktion definiert sind, führt das dann natürlich dazu, daß die Aktion NICHT erfüllt ist !	integer	6.0.7
CurrencyID	NULL	ID einer Währungs-Einheit (s. mi_GetUnits), in der die Preise für die Artikel des „virtuellen Warenkorbes“ („TreeNodeIDList“) bestimmt werden sollen (für evtl. Preis-Kriterien). Bei „NULL“ wählt die Prozedur die „DefaultCurrencyID“ aus „Settings“.	tinyint	6.0.7
PriceNodeCharacteristicID	NULL	ID eines (Preis-)Merkmals. Falls angegeben (nicht „NULL“), werden die Eigenschaften der Artikel des „virtuellen Warenkorbes“ („TreeNodeIDList“) als Preis für evtl. Preis-Kriterien der Aktion herangezogen.	smallint	6.0.7

Rückgabe

(parameterunabhängig)

Spaltenname	Beschreibung	SQL-Datentyp⁴⁾	ab Version
TreeNodeID	ID eines in „TreeNodeIDList“ angegebenen Elementes im Artikelbaum, das die Bedingungen der „CampaignID“ erfüllt	integer	6.0.7

Output-Parameter

Die Prozedur hat keine Output-Parameter.

Mögliche Return-Codes

Code	Beschreibung	Quelle ⁵⁾
-1204	Fehlender oder falscher Eintrag in CampaignSettings	nur indirekt
-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	direkt und indirekt
-540	Falsches Format	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
-503	Fehlerhafte Daten in einer Tabelle - genauere Fehlermeldung auf der Standardausgabe	nur indirekt
-502	Die Parameter-Werte der Prozedur können nicht verarbeitet werden (kein passendes Trennzeichen)	nur indirekt
-500	Falsche Parameter	direkt und indirekt
-333	Ein benötigter Steuersatz ist nicht bekannt oder konnte nicht ermittelt werden	nur indirekt
-283	Der Benutzer hat keine Berechtigung, Eigenschaften zu diesem(n) Merkmal(en) zu ermitteln	nur indirekt
-221	Es konnte kein rekursives Merkmal mit der Standardwährung als Einheit ermittelt werden	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]
6.5.4	2013-04-29	„StartProcedure“-Call wg. UTF-8 Unterstützung angepasst
6.0.8	2012-06-29	Der Name eines benötigten „CampaignSettings“-Eintrags hat sich geändert ⇒ Anpassung
6.0.7	2012-05-08	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_CheckCampCondsForTNIDs_Ad im Engine Playground öffnen

cURL

Unformatierte Ausgabe:

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

Mit xmllint ⁶⁾ formatierte Ausgabe:

curl -X POST  'http://<partner>-<project>.dstore.de/default/engine/om_CheckCampCondsForTNIDs_Ad?TreeNodeIDList=<value>&CampaignID=<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_CheckCampCondsForTNIDs_Ad',
		array(
			'TreeNodeIDList' => '<value>',
			'CampaignID' => <value>,
			// 'QuantityList' => NULL,
			// 'PersonID' => NULL,
			// 'CurrencyID' => NULL,
			// 'PriceNodeCharacteristicID' => 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_CheckCampCondsForTNIDs_Ad">
			<Parameters>
				<Parameter Name="TreeNodeIDList"><!-- varchar value --></Parameter>
				<Parameter Name="CampaignID"><!-- integer value --></Parameter>
				<!-- <Parameter Name="QuantityList">NULL</Parameter> -->
				<!-- <Parameter Name="PersonID">NULL</Parameter> -->
				<!-- <Parameter Name="CurrencyID">NULL</Parameter> -->
				<!-- <Parameter Name="PriceNodeCharacteristicID">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