Gibt angelegte Verkaufs-Aktionen (die sogenannten „Campaigns“) zurück
HTTP-Method | GET |
HTTP-Auth | Optional |
Tags | |
Engine-Kategorie | order management |
Engine-Typ | Daten-Ermittlung |
Letzte Aktualisierung | 7.0.7 (2015-01-29) |
Name 1) | Standard-Wert | Beschreibung 2) | SQL-Datentyp3) | ab Version |
---|---|---|---|---|
CampaignID | NULL | ID einer Verkaufs-Aktion. Falls angegeben, wird nur der entsprechende Datensatz zu dieser Aktion ermittelt. | integer | 6.0.0 |
CampaignTypeID | NULL | Wird nur im Fall „CampaignID = NULL“ beachtet ! ID eines „Typs“ von „Campaigns“ (s. om_GetCampaignTypes_Ad; Typen sind dazu da, den Benutzer-Kreis zu definieren - wie z.B. „nur Webshop“). Falls angegeben, werden nur Aktionen dieses Typs ermittelt. | tinyint | 6.0.0 |
Active | NULL | Wird nur im Fall „CampaignID = NULL“ beachtet ! Mögliche Werte : * „NULL“ : Keine Filterung * „0“ : Nur INAKTIVE Aktionen (Datensätze mit „Active = 0“) * „1“ : Nur AKTIVE Aktionen (Datensätze mit „Active = 1“) | tinyint | 6.0.0 |
FilterByPeriodStart_MinDate | NULL | Wird nur im Fall „CampaignID = NULL“ beachtet ! Falls angegeben, werden nur Aktionen, für die ein „Gültigkeits-Zeitraum“ definiert wurde, der an einem Zeitpunkt beginnt, der „>=“ diesem (Datums-)Wert ist, ermittelt. | datetime | 6.0.0 |
FilterByPeriodStart_MaxDate | NULL | Wird nur im Fall „CampaignID = NULL“ beachtet ! Falls angegeben, werden nur Aktionen, für die ein „Gültigkeits-Zeitraum“ definiert wurde, der an einem Zeitpunkt beginnt, der „⇐“ diesem (Datums-)Wert ist, ermittelt. | datetime | 6.0.0 |
Spaltenname | Beschreibung | SQL-Datentyp4) | 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 |
CampaignTypeID | ID des „Typs“ (von Verkaufs-Aktionen), der „CampaignID“ angehört. Anmerkung : Typen sind dazu da, den (dStore-)Benutzer-Kreis zu definieren, von dem die Aktion nur verwendet werden darf (s. om_GetCampaignTypeRules_Ad). | tinyint | 6.0.0 |
CampaignType | Bezeichnung des Typs „CampaignTypeID“ | varchar(100) | 6.0.0 |
Active | Status der Verkaufs-Aktion „CampaignID“ (derzeit nur „0“ - für „inaktiv“ - und „1“ - für „aktiv“ - möglich. Weitere Status wie „aktiv, nur Test“ in Zukunft möglich) | tinyint | 6.0.0 |
(parameterunabängige Sortierung)
Die Prozedur hat keine Output-Parameter.
Code | Beschreibung | Quelle 5) |
---|---|---|
-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 |
Die Rückgabe erfolgt als XML-Dokument welches gegen das Schema Response/EngineProcedure_v1_0.xsd validiert.
7.0.7 | 2015-01-29 | Interne Änderung : Datentyp-Erweiterung des „ReferenceKey“ [für „_mi_StartProcedure“-Aufruf] |
6.5.0 | 2012-09-17 | Holger Wies : Bugfix: Fehlende „DISTINCT“s in den Fällen, dass „FilterByPeriodStart_…“ gesetzt ist, ergänzt |
6.0.0 | 2010-03-26 | Erstmalig in dieser Version erstellt |
Der folgende Link öffnet in einem separaten Fenster den Engine Playground der fest mit dem dbap-demo System verbunden ist:
Unformatierte Ausgabe:
curl -X GET 'http://<partner>-<project>.dstore.de/default/engine/om_GetCampaigns_Ad'
Mit xmllint 6) formatierte Ausgabe:
curl -X GET 'http://<partner>-<project>.dstore.de/default/engine/om_GetCampaigns_Ad' | xmllint --format -
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_GetCampaigns_Ad', array( // 'CampaignID' => NULL, // 'CampaignTypeID' => NULL, // 'Active' => NULL, // 'FilterByPeriodStart_MinDate' => NULL, // 'FilterByPeriodStart_MaxDate' => NULL ) ); $service->execute($request); $xml_result = $request->getResponse()->getBody()->toSimpleXmlDocument(); $ResultSet = $xml_result->getRowsAsArray();
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_GetCampaigns_Ad"> <Parameters> <!-- <Parameter Name="CampaignID">NULL</Parameter> --> <!-- <Parameter Name="CampaignTypeID">NULL</Parameter> --> <!-- <Parameter Name="Active">NULL</Parameter> --> <!-- <Parameter Name="FilterByPeriodStart_MinDate">NULL</Parameter> --> <!-- <Parameter Name="FilterByPeriodStart_MaxDate">NULL</Parameter> --> </Parameters> </Procedure> </Batch> </ListOfBatches>