placeholder Command:  ORDERINGS 


Short version Long version Changes Example

Mandatory: no
max. Occurrence:  unbounded
Description:
This tag is used as container for commands regarding orderings from the branch to the central office.
Notes:
In the NSM form the UC3 application the content of this command is handled with NSM item 48.
 
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 an ordering.
Notes:
To use the supported modes in the right way the following information can be helpful:
Mode Description
'read' Returns the general information (order number and delivery date) if only the order number is set.
Returns additionally the article/item information if the position number(s) within is/are set (see examples).
'read+' Returns the next general order information (order number and delivery date) whose order number is following the delivered order number if only the order number is set.
Returns the next article/item information of an order whose position number is following the delivered position number if the position number within is set (see examples).
'read-' Returns the preceding general order information (order number and delivery date) whose order number is following the delivered order number if only the order number is set.
Returns the preceding article/item information of an order whose position number is preceding the delivered position number if the position number within the request is set (see examples).
'readall' Returns all available orderings (including the assigned article/item information) if only the order number is set to 0.
Returns a complete ordering (including the assigned article/item information) if the order number is > 0.
'delete' Delete one or more article(s)/item(s) from an ordering.
It is not possible to delete an orderig with the mode <'delete'>.
For that use the mode <'deleteall'>.
'deleteall' Deletes an ordering as whole if the order number is > 0.
Delete all orderings (including all article/item information) if the ordner number is set to 0.

   
Mandatory: yes
max. Occurrence: 1
Datatype: int
Range: 1 - 999 999
Nillable: no
Description:
The number of the order. Each ordering is identfied by an order number.
   
Mandatory: no
max. Occurrence: 1
Datatype: dateTime
Range: -
Nillable: yes
Description:
Date and time the delivery is desired in the branch.
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
   
Mandatory: no
max. Occurrence:  1
Description:
A container for the desired articles/items.
     
Mandatory: yes
max. Occurrence:  unbounded
Description:
Container for the article/item information.
       
Mandatory: yes
max. Occurrence: 1
Datatype: short
Range: 1 - 9 999
Nillable: no
Description:
A unique position number within an ordering by which the article/item is identified.
       
Mandatory: no
max. Occurrence: 1
Datatype: short
Range: 1 - 9 999
Nillable: no
Description:
The number of the department the article/item is belonging to.
       
Mandatory: no
max. Occurrence: 1
Datatype: int
Range: 1 - 999 999
Nillable: no
Description:
The number of the article/item.
       
Mandatory: no
max. Occurrence: 1
Datatype: string
Range: max. 13 characters
Nillable: no
Description:
The unique article number. Necessary to identify the article
       
Mandatory: no
max. Occurrence: 1
Datatype: string
Range: max. 100 characters
Nillable: no
Description:
The name of the article/item.
       
Mandatory: no
max. Occurrence: 1
Datatype: string
Range: max. 100 characters
Nillable: no
Description:
Defines the type by which an article/item shall be ordered.
Possible values are:
Value Description
ORDER_ARTICLE_BY_WEIGHT The article/item is ordered by weight.
ORDER_ARTICLE_BY_COUNT The article/item is ordered by count/pieces.

       
Mandatory: no
max. Occurrence: 1
Datatype: int
Range: 0 - 999 999 999
Nillable: no
Description:
The weight or quantity for the ordered article/item (depending on the tag <quantity_type>).
       
Mandatory: no
max. Occurrence: 1
Datatype: int
Range: 0 - 999 999 999
Nillable: no
Description:
A customer specific identifier to select in which way the delivery of the article/item is desired,
e.g. frozen, prepacked, ...
   
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