placeholder Command:  PROOF OF ORIGIN LOTS 


Short version Long version Changes Example

Mandatory: no
max. Occurrence:  unbounded
Description:
This tag is used as container for commands regarding proof of origin lots.
 
Mandatory: yes
max. Occurrence:  unbounded
Supported modes: delete Delete the named item.
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:
For an existing proof of origin type definitions one or more lot(s) can be defined, if the lot is a "Multiple lot" (value for single_lot="0") or "Auto lot id" (value for single_lot="2").
Notes:
To use the proof of origin functionality on the device it is necessary to activate it.
"Proof of origin" 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 proof of origin functionality itself doesn't work without a license key.

If this <proof_of_origin_type> doesn't exist in the <proof_of_origin_type_definitions> then it's not possible to create a lot for this type.
In this case there will be an exception in the response file.
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.

When using the mode ''write'' at least one lot field <proof_of_origin_lots> must be set. Otherwise the command has no effect.
For the mode ''readall'' the following information can be helpful:
The table below shows values for the mandatory elements.
proof_of_origin_type lot_id Comment
no value no value All lots independent on its proof of origin type will be returned.
no value value All lots that are subsequent to the value of <lot_id> will be returned, independent on its proof of origin type.
value no value All lots belonging to the proof of origin type <proof_of_origin_type> will be returned.
value value All lots that are subsequent to the value of <lot_id> and belonging to the proof of origin type <proof_of_origin_type> will be returned.


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. 20 characters
Nillable: no
Description:
The proof of origin type
The value of the tag is corresponding to the tag <proof_of_origin_type> of the command <proof_of_origin_type_definitions> .
Notes:
If this <proof_of_origin_type> doesn't exist in the command <proof_of_origin_type_definitions> then it's not possible create a lot for this type.
In this case there will be an exception in the response file.
   
Mandatory: yes
max. Occurrence: 1
Datatype: string
Range: max. 100 characters
Nillable: no
Description:
The identfier of the lot.
The lot ID can only be defined for Multiple lot or Auto lot id.
All settings for the proof_of_origin_lot are saved for the lot_id.
If this field is not set the value of the tag <field_text> with the field no 1 is the default.
   
Mandatory: no
max. Occurrence:  1
Description:
This tag contains the following child fields (up to 20) that defines this lot.
     
Mandatory: yes
max. Occurrence:  20
Description:
Each proof of origin lot field contains exactly the information for one field of the <proof_of_origin_type_definitions> mask.
       
Mandatory: yes
max. Occurrence: 1
Datatype: short
Range: 1 - max. number of fields.
Nillable: no
Description:
Field number corresponding to the field <field_no> of command <proof_of_origin_type_definitions>.
       
Mandatory: no
max. Occurrence: 1
Datatype: string
Range: max. 100 characters
Nillable: no
Description:
The text assigned to the field for this <lot_id> .
Notes:
If the value for this field is not set it's defined with the default value 1.
   
Mandatory: no
max. Occurrence: 1
Datatype: dateTime
Range: -
Nillable: yes
Description:
The last time when the record was changed.
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