Benutzer-Werkzeuge

Webseiten-Werkzeuge

Action disabled: source

engine:procedures:om_getcampaignperiods_ad

om_GetCampaignPeriods_Ad

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-MethodGET
HTTP-AuthOptional
Tags
Engine-Kategorieorder management
Engine-TypDaten-Ermittlung
Letzte Aktualisierung7.0.7 (2015-01-29)

Parameter

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.
integer6.0.0
PeriodDefinitionIDNULL 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.
tinyint6.0.0
FromDateNULL 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.
datetime6.0.8
ToDateNULL 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.
datetime6.0.8

Rückgabe

wenn CampaignID is NOT NULL

Spaltenname Beschreibung SQL-Datentyp4) ab Version
CampaignIDID einer Verkaufs-Aktion (identisch mit „CampaignID“)
integer6.0.8
PeriodDefinitionIDID einer (nur) für die Verkaufs-Aktion „CampaignID“ geltenden Gültigkeitszeitraum-Definition, aufgrund der der Zeitraum „PeriodStartDateAndTime“ bis „PeriodEndDateAndTime“ generiert wurde
tinyint6.0.0
PeriodDefinitionNameBezeichnung 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
PeriodStartDateAndTimeBeginn des Gültigkeitszeitraums
datetime6.0.0
PeriodStartDateAndTime_char„PeriodStartDateAndTime“ als „string“ im Format „01.04.2001 17:52:23:548“
varchar(23)6.0.0
PeriodEndDateAndTimeEnde des Gültigkeitszeitraums
datetime6.0.0
PeriodEndDateAndTime_char„PeriodEndDateAndTime“ als „string“ im Format „01.04.2001 17:52:23:548“
varchar(23)6.0.0
PeriodStatusSumme 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
tinyint6.0.0
Sortierung der Rückgabe

(parameterunabängige Sortierung)

  • CampaignID (aufsteigend)
  • PeriodStartDateAndTime (aufsteigend)

wenn CampaignID is NULL

Spaltenname Beschreibung SQL-Datentyp5) ab Version
CampaignIDID einer Verkaufs-Aktion
integer6.0.8
PeriodDefinitionIDID einer (nur) für die Verkaufs-Aktion „CampaignID“ geltenden Gültigkeitszeitraum-Definition, aufgrund der der Zeitraum „PeriodStartDateAndTime“ bis „PeriodEndDateAndTime“ generiert wurde
tinyint6.0.0
PeriodDefinitionNameBezeichnung 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
PeriodEndDateAndTimeEnde des Gültigkeitszeitraums
datetime6.0.0
PeriodEndDateAndTime_char„PeriodEndDateAndTime“ als „string“ im Format „01.04.2001 17:52:23:548“
varchar(23)6.0.0
PeriodStartDateAndTimeBeginn des Gültigkeitszeitraums
datetime6.0.0
PeriodStartDateAndTime_char„PeriodStartDateAndTime“ als „string“ im Format „01.04.2001 17:52:23:548“
varchar(23)6.0.0
PeriodStatusSumme 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
tinyint6.0.0
ActiveStatus 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)
tinyint7.0.4
CampaignDescriptionBeschreibung (kann Kommentar, Zeitraum etc. enthalten) der Verkaufs-Aktion „CampaignID“
varchar(255)7.0.4
CampaignNameBezeichnung der Verkaufs-Aktion „CampaignID“
varchar(100)7.0.4
CampaignTypeIDID 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).
tinyint7.0.4
Sortierung der Rückgabe

(parameterunabängige Sortierung)

  • CampaignID (aufsteigend)
  • PeriodEndDateAndTime (aufsteigend)

Output-Parameter

Die Prozedur hat keine Output-Parameter.

Mögliche Return-Codes

Code Beschreibung Quelle 6)
-569Der Benutzer hat kein Ausführungsrecht für die Prozedurnur indirekt
-567Die Prozedur darf z. Zt. nicht ausgeführt werdennur indirekt
-566Die Prozedur darf mit den übergebenen Parametern nicht ausgeführt werdennur indirekt
-535Das Datum liegt nicht in der Vergangenheitnur indirekt
-530Der Wert ist nicht konvertierbarnur indirekt
-510Der Benutzer ist nicht registriertnur indirekt
-504Es ist ein Problem aufgetreten, das nicht gelöst werden kann, Prozedur wird daher abgebrochennur indirekt
-500Falsche Parameterdirekt 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-29Interne Änderung : Datentyp-Erweiterung des „ReferenceKey“ [für „_mi_StartProcedure“-Aufruf]
7.0.4 2014-03-19Neue Rückgabespalten im Fall „CampaignID is NULL“, s. Ticket #3608
6.5.1 2012-11-02Berü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-17Fehler : 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-291. 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-26Erstmalig 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:

cURL

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 -
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_GetCampaignPeriods_Ad',
		array(
			'CampaignID' => <value>,
			// 'PeriodDefinitionID' => NULL,
			// 'FromDate' => NULL,
			// 'ToDate' => 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_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>
1)
Pflichtparameter sind unterstrichen
6)
direkt meint „von der Prozedur selber“ und indirekt meint „von intern aufgerufenen Unterprozeduren“
7)
I.d.R. auf Unix-artigen Systemen bereits installiert, Bestandteil der libxml2, siehe http://www.xmlsoft.org
engine/procedures/om_getcampaignperiods_ad.txt · Zuletzt geändert: 11.01.2016 (Externe Bearbeitung)