om_GetCampaignItemCondParts_Ad [dstore]

Inhaltsverzeichnis

om_GetCampaignItemCondParts_Ad

om_GetCampaignItemCondParts_Ad

Gibt zu einer auf Artikel-Bedingungen basierenden Verkaufs-Aktions-Bedingung die um Mengen/Warenwert-Kriterien erweiterten zugehörigen Bedingungs-Teile zurück.

Hintergrund : Ein Bedingungs-Teil ist Bestandteil einer sogenannten Artikel-Bedingung, deren Aufbau in im_GetItemConditionParts_Ad beschrieben ist. Mit einem solchen Bedingungsteil können Dinge wie „Schuhe der Marke X“ abgebildet werden. Solche Bedingungen müssen aber häufig noch ein Mengen- und/oder Warenwert-Kriterium bekommen, um einen „vollständigen Bedingungteil“ zu erhalten - wie etwa : „mind. 2 Schuhe der Marke X im Wert von 250 Euro“.

Hinweise :
1.) Ob die „…PriceSum…“-Angaben in Brutto oder Netto angegeben sind, bestimmt ein entsprechender „CampaignSettings“-Eintrag (s. om_GetCampaignSettingEntry) zum Schlüssel „PriceConditionsInNet“ (zu der Verkaufs-Aktion, der die Bedingung „ConditionID“ zugeordnet ist).
2.) Die Grenzen der durch die „From…“- und „To…“-Werte bzw. „Min…“- und „Max…“-Angaben definierten Bereiche (wenn nicht „NULL“) sind immer als „einschließlich“ zu verstehen.
3.) NULL„ für „ConditionID“ UND „ItemConditionPartID“ anzugeben ist natürlich nicht erlaubt !

HTTP-Method	GET
HTTP-Auth	Optional
Alias	om_GetCampaignItemConditionParts_Ad
Tags	[om, Get, Campaign, Item, Condition, Parts, 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
ConditionID		ID einer auf Artikel-Bedingungen basierenden Verkaufs-Aktions-Bedingung, zu der die erweiterten Artikel-Bedinguns-Teile ermittelt werden sollen. Mögliche Werte : s. om_GetCampaignConditions_Ad (Rückgabespalte „ConditionID“ zur „CriteriaTypeID = 1“).	integer	6.0.7
ItemConditionPartID	NULL	ID eines Artikel-Bedingungs-Teils. Angeben, um nur die Erweiterung dieses Teils (wenn Bestandteil von „ConditionID“) zu erhalten bzw. um ALLE Verkaufs-Aktions-Bedingungen zu ermitteln (wenn „ConditionID“ „NULL“ ist), zu denen dieser Teil gehört.	integer	6.0.7

Rückgabe

(parameterunabhängig)

Spaltenname	Beschreibung	SQL-Datentyp⁴⁾	ab Version
ConditionID	ID einer Verkaufs-Aktions-Bedingung (die auf einer Artikel-Bedingung basiert) - natürlich identisch mit „ConditionID“ wenn angegeben	integer	6.0.7
ItemConditionPartID	ID der Artikel-Bedingung, auf der „ConditionID“ basiert - natürlich identisch mit „ItemConditionPartID“ wenn angegeben	integer	6.0.7
ExtendedItemCondPartDescr	Bezeichnung des (um Mengen- und/oder Warenwert-Kriterium erweiterten) Bedingungs-Teils „ItemConditionPartID“	varchar(255)	6.0.7
LevelIDs	Um den (Artikel-)Bedingungs-Teil „ItemConditionPartID“ zu erfüllen, muß die Hierarchie („LevelID“) eines Artikel-Elementes aus der hier angegebenen Menge der Hierarchien („LevelID“s) kommen. Sonderfall “,,„ bedeutet „beliebige Hierarchie“.	varchar(50)	6.0.7
DomainTreeNodeIDs	Um den (Artikel-)Bedingungs-Teil „ItemConditionPartID“ zu erfüllen, muß ein Element im Artikelbaum ein Vorgänger-Element besitzen, dessen „TreeNodeID“ aus der hier angegebenen Menge von IDs kommt. Sonderfall “,,„ bedeutet „beliebiger Vorgänger“.	varchar(200)	6.0.7
NodeCharacteristicID	ID eines Merkmals. Um „ItemConditionPartID“ zu erfüllen, muß ein Element im Artikelbaum eine Eigenschaft zu diesem Merkmal besitzen, die der Bedingung („Operator1“ etc.) genügt. Sonderfall “-1„ : „KEINE Eigenschafts-Bedingung“ (ist also immer erfüllt).	smallint	6.0.7
Operator1	Operator für die Bedingung „Condition1“. Mögliche Werte : - “=„ - “!=„ / “<>„ - “~„ / “!~„ (LIKE / NOT LIKE) - “>„ - “<„ - “>=„ - “⇐„ - „IN“ / “!I„ (in / NICHT in Menge von „Value“-Werten) - „E“ / “!E„ (IRGENDEINE / KEINE Eigenschaft)	varchar(2)	6.0.7
Condition1	Bedingung, die in Verbindung mit „Operator1“ anzuwenden ist („NULL“, falls „Operator1“ den Wert „E“ oder “!E„ hat)	varchar(2000)	6.0.7
Operator2	Operator für die Bedingung „Condition2“. Mögliche Werte : - “<„ oder “⇐„, falls „Operator1“ “>„ oder “>=„ enthält - bel. Zeichen (Trennzeichen für Werte-Menge), falls „Operator1“ „IN“ oder “!I„ enthält	varchar(2)	6.0.7
Condition2	Bedingung, die in Verbindung mit „Operator2“ anzuwenden ist (nur belegt, wenn „Operator2“ den Wert “<„ oder “⇐„ enthält)	varchar(1000)	6.0.7
InheritDepth	Welche Eigenschaften zu „NodeCharacteristicID“ hinsichtlich Vererbung sollen bei Prüfung der Eigenschafts-Bedingung beachtet werden : “-1„ : Alle „0“ : unvererbte „1“ : direkte u. einfach geerbte „2“ : direkte u. einfach oder zweifach geerbte usw.	smallint	6.0.7
RecursiveEvaluation	Was soll zwecks Prüfung der Bedingung zu „NodeCharacteristicID“ (wenn rekursiv) gewählt werden ? „0“ : direkte Eigenschaft (also eine Merkmal-ID) „1“ : rekursiv ausgewertete Eigenschaft „2“ : zugehör. Beschreibung der Eigenschaft (also der Merkmal-ID)	tinyint	6.0.7
MinNumberOfItems	Die Anzahl VERSCHIEDENER Artikel-Elemente, die den Bedingungs-Teil „ItemConditionPartID“ erfüllen, muß zwischen diesem Wert und „MaxNumberOfItems“ (sofern nicht „NULL“) liegen (um „ConditionID“ zu erfüllen)	integer	6.0.7
MaxNumberOfItems	Die Anzahl VERSCHIEDENER Artikel-Elemente, die den Bedingungs-Teil „ItemConditionPartID“ erfüllen, muß zwischen „MinNumberOfItems“ und diesem Wert (sofern nicht „NULL“) liegen (um „ConditionID“ zu erfüllen)	integer	6.0.7
FromQuantity	Die Gesamt-Menge (Summe „Quantity“) ALLER Artikel-Elemente, die den Bedingungs-Teil „ItemConditionPartID“ erfüllen, muß zwischen diesem Wert und „ToQuantity“ (sofern nicht „NULL“) liegen (um „ConditionID“ zu erfüllen)	integer	6.0.7
ToQuantity	Die Gesamt-Menge (Summe „Quantity“) ALLER Artikel-Elemente, die den Bedingungs-Teil „ItemConditionPartID“ erfüllen, muß zwischen „FromQuantity“ und diesem Wert (sofern nicht „NULL“) liegen (um „ConditionID“ zu erfüllen)	integer	6.0.7
FromItemBasicPrice	Der EINZEL-Preis, den „_om_GetBasicPrices“ für ein Artikel-Element, das den Bedingungs-Teil „ItemConditionPartID“ erfüllt, liefert, muß zwischen diesem Wert und „ToItemBasicPrice“ (sofern nicht „NULL“) liegen (um „ConditionID“ zu erfüllen)	money	6.0.7
ToItemBasicPrice	Der EINZEL-Preis, den „_om_GetBasicPrices“ für ein Artikel-Element, das den Bedingungs-Teil „ItemConditionPartID“ erfüllt, liefert, muß zwischen „FromItemBasicPrice“ und diesem Wert (sofern nicht „NULL“) liegen (um „ConditionID“ zu erfüllen)	money	6.0.7
FromBasicPriceSum	Die Gesamt-Summe für alle Artikel-Elemente (Summe aller Einzelpreise, die „_om_GetBasicPrices“ liefert, mit der jeweiligen „Quantity“ multipliziert), die den Bedingungsteil „ItemConditionPartID“ erfüllen, muß zw. diesem Wert und „ToBasicPriceSum“ liegen	money	6.0.7
ToBasicPriceSum	Die Gesamt-Summe für alle Artikel-Elemente (Summe aller Einzelpreise, die „_om_GetBasicPrices“ liefert, mit der jeweiligen „Quantity“ multipliziert), die den Bedingungsteil „ItemConditionPartID“ erfüllen, muß zw. „FromBasicPriceSum“ und diesem Wert liegen	money	6.0.7

Sortierung der Rückgabe

(parameterunabängige Sortierung)

ConditionID (aufsteigend)
ItemConditionPartID (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	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	Doku bzgl. Datentyp der Rückgabespalten „Condition1“ und „Condition2“ angepasst
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_GetCampaignItemCondParts_Ad im Engine Playground öffnen

cURL

Unformatierte Ausgabe:

curl -X GET  'http://<partner>-<project>.dstore.de/default/engine/om_GetCampaignItemCondParts_Ad?ConditionID=<value>'

Mit xmllint ⁶⁾ formatierte Ausgabe:

curl -X GET  'http://<partner>-<project>.dstore.de/default/engine/om_GetCampaignItemCondParts_Ad?ConditionID=<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_GetCampaignItemCondParts_Ad',
		array(
			'ConditionID' => <value>,
			// 'ItemConditionPartID' => 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_GetCampaignItemCondParts_Ad">
			<Parameters>
				<Parameter Name="ConditionID"><!-- integer value --></Parameter>
				<!-- <Parameter Name="ItemConditionPartID">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