Gibt die Gültigkeitszeiträume einer Verkaufs-Aktion (eine sogenannte „Campaign“) zurück.
Diese Zeiträume können nicht direkt eingetragen werden, sondern werden immer über sogenannte „Definitionen“ generiert, s. om_ModifyCampaignPeriodDefs_Ad.
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 | ID einer Verkaufs-Aktion, zu der die hinterlegten Gültigkeitszeiträume ermittelt werden sollen. Wenn „NULL“ übergeben wird, muß „FromDate“ und „ToDate“ angegeben sein, es werden dann alle Aktionen mit entsprechend passenden Zeiträumen ermittelt. | integer | 6.0.0 | |
PeriodDefinitionID | NULL | ID einer (nur) für die Verkaufs-Aktion „CampaignID“ geltenden Gültigkeitszeitraum-Definition. Falls angegeben, werden nur die aus dieser Definition resultierenden Zeiträume ermittelt. Wird nicht beachtet, wenn „NULL“ für „CampaignID“ angegeben ist. | tinyint | 6.0.0 |
FromDate | NULL | Wenn angegeben (Pflicht falls „CampaignID = NULL“), muß auch „ToDate“ übergeben werden. Dann werden alle Zeiträume beachtet, deren Anfang („PeriodStartDateAndTime“) vor „ToDate“ liegt und deren Ende („PeriodEndDateAndTime“) hinter „FromDate“ liegt. | datetime | 6.0.8 |
ToDate | NULL | Wenn angegeben (Pflicht falls „CampaignID = NULL“), muß auch „FromDate“ übergeben werden. Dann werden alle Zeiträume beachtet, deren Anfang („PeriodStartDateAndTime“) vor „ToDate“ liegt und deren Ende („PeriodEndDateAndTime“) hinter „FromDate“ liegt. | datetime | 6.0.8 |
Spaltenname | Beschreibung | SQL-Datentyp4) | ab Version |
---|---|---|---|
CampaignID | ID einer Verkaufs-Aktion (identisch mit „CampaignID“) | integer | 6.0.8 |
PeriodDefinitionID | ID einer (nur) für die Verkaufs-Aktion „CampaignID“ geltenden Gültigkeitszeitraum-Definition, aufgrund der der Zeitraum „PeriodStartDateAndTime“ bis „PeriodEndDateAndTime“ generiert wurde | tinyint | 6.0.0 |
PeriodDefinitionName | Bezeichnung der Definition „PeriodDefinitionID“, wie z.B. „Jeden Montag zwischen 10 und 15 Uhr (vom 29.03.2010 bis zum 12.04.2010)„ | varchar(100) | 6.0.0 |
PeriodStartDateAndTime | Beginn des Gültigkeitszeitraums | datetime | 6.0.0 |
PeriodStartDateAndTime_char | „PeriodStartDateAndTime“ als „string“ im Format „01.04.2001 17:52:23:548“ | varchar(23) | 6.0.0 |
PeriodEndDateAndTime | Ende des Gültigkeitszeitraums | datetime | 6.0.0 |
PeriodEndDateAndTime_char | „PeriodEndDateAndTime“ als „string“ im Format „01.04.2001 17:52:23:548“ | varchar(23) | 6.0.0 |
PeriodStatus | Summe von Status-Werten für den Gültigkeitszeitraum (s. om_GetCamPeriodStatusValues_Ad), wie z.B. „132“, was „vom Benutzer geänderter Zeitraum“ („4“) und „aktiv“ („128“) bedeutet | tinyint | 6.0.0 |
(parameterunabängige Sortierung)
Spaltenname | Beschreibung | SQL-Datentyp5) | ab Version |
---|---|---|---|
CampaignID | ID einer Verkaufs-Aktion | integer | 6.0.8 |
PeriodDefinitionID | ID einer (nur) für die Verkaufs-Aktion „CampaignID“ geltenden Gültigkeitszeitraum-Definition, aufgrund der der Zeitraum „PeriodStartDateAndTime“ bis „PeriodEndDateAndTime“ generiert wurde | tinyint | 6.0.0 |
PeriodDefinitionName | Bezeichnung der Definition „PeriodDefinitionID“, wie z.B. „Jeden Montag zwischen 10 und 15 Uhr (vom 29.03.2010 bis zum 12.04.2010)„ | varchar(100) | 6.0.0 |
PeriodEndDateAndTime | Ende des Gültigkeitszeitraums | datetime | 6.0.0 |
PeriodEndDateAndTime_char | „PeriodEndDateAndTime“ als „string“ im Format „01.04.2001 17:52:23:548“ | varchar(23) | 6.0.0 |
PeriodStartDateAndTime | Beginn des Gültigkeitszeitraums | datetime | 6.0.0 |
PeriodStartDateAndTime_char | „PeriodStartDateAndTime“ als „string“ im Format „01.04.2001 17:52:23:548“ | varchar(23) | 6.0.0 |
PeriodStatus | Summe von Status-Werten für den Gültigkeitszeitraum (s. om_GetCamPeriodStatusValues_Ad), wie z.B. „132“, was „vom Benutzer geänderter Zeitraum“ („4“) und „aktiv“ („128“) bedeutet | tinyint | 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 | 7.0.4 |
CampaignDescription | Beschreibung (kann Kommentar, Zeitraum etc. enthalten) der Verkaufs-Aktion „CampaignID“ | varchar(255) | 7.0.4 |
CampaignName | Bezeichnung der Verkaufs-Aktion „CampaignID“ | varchar(100) | 7.0.4 |
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 | 7.0.4 |
(parameterunabängige Sortierung)
Die Prozedur hat keine Output-Parameter.
Code | Beschreibung | Quelle 6) |
---|---|---|
-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] |
7.0.4 | 2014-03-19 | Neue Rückgabespalten im Fall „CampaignID is NULL“, s. Ticket #3608 |
6.5.1 | 2012-11-02 | Berücksichtigung der neuen „Historien“-Tabelle „CampaignPeriodsHistory“ [in die von Zeit zu Zeit Daten aus „CampaignPeriods“ durch „_om_MoveExpiredCampaignPeriods“ verschoben werden] |
6.5.0 | 2012-09-17 | Fehler : Die intern verwendeten „Parameter…“-Variablen für den „_mi_StartProcedure“-Aufruf müssen 16384 bytes lang sein und nicht mehr nur 255 ! |
6.0.8 | 2012-06-29 | 1. Neue Parameter „FromDate“ und „ToDate“ 2. Neue Rückgabespalte „CampaignID“ 3. Performance-Verbesserung bei gegebener „CampaignID“ [bessere Index-Ausnutzung durch Unterscheidung nach „PeriodDefinitionID“] |
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_GetCampaignPeriods_Ad?CampaignID=<value>'
Mit xmllint 7) formatierte Ausgabe:
curl -X GET 'http://<partner>-<project>.dstore.de/default/engine/om_GetCampaignPeriods_Ad?CampaignID=<value>' | 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_GetCampaignPeriods_Ad', array( 'CampaignID' => <value>, // 'PeriodDefinitionID' => NULL, // 'FromDate' => NULL, // 'ToDate' => 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_GetCampaignPeriods_Ad"> <Parameters> <Parameter Name="CampaignID"><!-- integer value --></Parameter> <!-- <Parameter Name="PeriodDefinitionID">NULL</Parameter> --> <!-- <Parameter Name="FromDate">NULL</Parameter> --> <!-- <Parameter Name="ToDate">NULL</Parameter> --> </Parameters> </Procedure> </Batch> </ListOfBatches>