placeholder Command:  PROMOTION VALIDITIES 


Short version Long version Changes Example

Mandatory: no
max. Occurrence:  unbounded
Description:
This tag is used as container for commands regarding promotion validities.
 
Mandatory: yes
max. Occurrence:  unbounded
Supported modes: delete Delete the named item.
deleteall Delete all items.
read Read the named item.
read+ Read the following item.
read- Read the previous item.
readall Read all items from the desired device(s). This doesn't mean comparable reading as in the L2 protocol.
write Write the named item.
Description:
This command is used for creating, manipulating or deleting a validity of a promotion.
Notes:
To use the promotion functionality on the device it is necessary to activate it.
"Promotion" is an option which needs a license key to be enabled (uc3options.xml).
The XML command will be processed by the device without a license key.
The promotion functionality itself doesn't work without a license key.

For the mode ''deleteall'' the value of <promotion_validity_id> will not be evaluated.
For the mode ''readall'' all validities that are equal or greater the value of <promotion_validity_id> will be returned.
If the value is empty all available validities will be returned.

The values of the tags <start_date> and <end_date> can be set/reseted partially.
The values for the apply range(s) can not be set/reseted partially.
If the command contains the tag <apply_range> then an already existing apply range(s) will be deleted and replaced by the new one.

If a promotion validity is deleted its assigned articles/items set by the commands <article_promotions> will be deleted, too.
This doesn't have influence on the article/items created by using the command <articles>.
   
Mandatory: yes
max. Occurrence: 1
Datatype: string
Range: max. 50 characters
Nillable: no
Description:
String that identifies the promotion validity.
   
Mandatory: no
max. Occurrence: 1
Datatype: dateTime
Range: -
Nillable: yes
Description:
The date when the promotion becomes valid.
CCYY-MM-DDThh:mm:ss
The format is as following:
C = Century
Y = Year
M = Month
D = Day
T = Separator between date and time
h = hour
m = minute
s = second
Notes:
The values of the tags <start_date> and <end_date> can be set/reseted partially.
   
Mandatory: no
max. Occurrence: 1
Datatype: dateTime
Range: -
Nillable: yes
Description:
The date when the validation of the promotion ends.
CCYY-MM-DDThh:mm:ss
The format is as following:
C = Century
Y = Year
M = Month
D = Day
T = Separator between date and time
h = hour
m = minute
s = second
Notes:
The values of the tags <start_date> and <end_date> can be set/reseted partially.
   
Mandatory: no
max. Occurrence:  unbounded
Description:
The range applied to the promotion validity.
If no apply range is defined the promotion becomes valid from start date till end date.
If the promotion shall become valid only on predefined days or within a predefined range of time the definition of at least one apply range is obligatory.
In the case of having assigned several apply ranges they are linked as or . That means if one apply range becomes valid then the promotion becomes valid.
Notes:
The values for the apply range(s) can not be set/reseted partially.
If the command contains the tag <apply_range> then an already existing apply range(s) will be deleted and replaced by the new one.
     
Mandatory: yes
max. Occurrence: 1
Datatype: int
Range: 0 - 7
Nillable: no
Description:
Here you can define the day of the week the promotion becomes valid.
The following values are possible:
Value Description
0 All weekdays
1 Monday
2 Tuesday
3 Wedesday
4 Thursday
5 Friday
6 Saturday
7 Sunday

     
Mandatory: no
max. Occurrence: 1
Datatype: time
Range: -
Nillable: yes
Description:
If a start time is defined then the promotion becomes valid at this time of the weekday.
If a start time hasn't been defined the promotion becomes valid at 00:00 o'clock.
HH:MM:SS
The format is as following:
H = Hour
M = Minute
S = Second
     
Mandatory: no
max. Occurrence: 1
Datatype: time
Range: -
Nillable: yes
Description:
If an end time is defined then the promotion is valid till this time of the weekday.
If an end time hasn't been defined the promotion is valid the end of the day.
HH:MM:SS
The format is as following:
H = Hour
M = Minute
S = Second
   
Mandatory: no
max. Occurrence: 1
Datatype: dateTime
Range: -
Nillable: yes
Description:
CCYY-MM-DDThh:mm:ss
The format is as following:
C = Century
Y = Year
M = Month
D = Day
T = Separator between date and time
h = hour
m = minute
s = second