Upsert Kitchen Display Controllers
post
/config/sim/v2/devices/upsertKitchenDisplayControllers
Updates provided fields if the KDS controller exists else inserts a new KDS controller.
Request
Supported Media Types
- application/json
- multipart/form-data
Header Parameters
-
Simphony-AuditTrailRef: string
Detail that identifies, who made the change.
KDS Controller Upsert request body
Root Schema : schema
Type:
objectModel for KDS Controllers Upsert Request
Show Source
-
autoBumpCheckCount:
integer
The number of checks allowed to appear on the KDS before automatically bumping.Example:
0 -
autoBumpTimeInSecs:
integer
The wait time before automatically bumping all closed orders after reaching the Check Count.Example:
0 -
bckupSVCHost:
object bckupSVCHost
An object representing the backup service host details associated with the KDS controller.
-
dbUpdateFrequencyInSecs:
integer
The number of seconds the KDS Controller waits to retrieve updates from the database.Example:
0 -
displayLanguage:
string
The ISO code of the language used to display all non-configurable text in KDS. This includes messages, title bars, column headers, and chit elements.Example:
1 -
enableResetAllTime:
boolean
A Boolean flag indicating to enable and set the Reset All Time to determine when the KDS Controller will delete all order data daily. Typically done at start of day to prevent recalling the previous day's orders.Example:
false -
expoRecallOption:
integer
Indicator of where to show orders when they are recalled from an Expo or SOS Display.Example:
0 -
extPostingFile1:
string
File name and directory path for the text file where the KDS transaction information is stored.Example:
file1.txt -
extPostingFile2:
string
File name and directory path for the text file where the KDS transaction information is stored.Example:
file2.txt -
extPostingFile3:
string
File name and directory path for the text file where the KDS transaction information is stored.Example:
file3.txt -
hierUnitId(required):
integer
Unique hierarchy unit valueExample:
1 -
itemStatusColors:
object itemStatusColors
An object containing an integer value representing the item status colors. Valid range is 0-13.
Value Color 0 Default 1 Black 2 White 3 Blue 4 Cyan 5 Dark Gray 6 Gray 7 Light Gray 8 Green 9 Magenta 10 Orange 11 Pink 12 Red 13 Yellow -
layoutColorsOverride:
object layoutColorsOverride
An object representing the layout colors override. Values can be specified either as hexadecimal color strings (ex '#FF5733') or as the names of known colors (ex, 'Red', 'Blue'). For a complete list of known color names, refer to the List Values section of the C&C API documentation.
-
maxItemsPerZone:
integer
The maximum number of items that can be added to a zone.Example:
0 -
mediaViewerURL:
string
The URL of the IIS website where the Media Viewer is defined.Example:
https://viewer -
name:
object name
Name of the KDS Controller. Required for creating new object.
-
numberOfZones:
integer
The number of kitchen zones to use for collecting food orders.Example:
0 -
objectNum(required):
integer
Object number of the KDS ControllerExample:
1 -
options:
string
A string value of 0s & 1s of length 32 representing the enablement or disablement of the options associated with the KDS Controller.Example:
11111111111110000000000000000000 -
prodCountDecrementType:
integer
Indicator of when to decrease the count of items from the production counter.Example:
0 -
prodCountIncrementType:
integer
Indicator of when to add ordered items to the production counter.Example:
0 -
svcHost:
object svcHost
An object representing the service host details associated with the KDS controller.
-
waitForPrepSubOrderInSecs:
integer
The number of seconds the KDS waits for Prep Suborders before showing an expo order as All Prep Done.Example:
0
Nested Schema : bckupSVCHost
Type:
objectAn object representing the backup service host details associated with the KDS controller.
Show Source
-
bckupSVCHostObjNum:
integer
Unique Id of the backup service host associated with the KDS Controller.Example:
1
Nested Schema : itemStatusColors
Type:
objectAn object containing an integer value representing the item status colors. Valid range is 0-13.
| Value | Color |
|---|---|
| 0 | Default |
| 1 | Black |
| 2 | White |
| 3 | Blue |
| 4 | Cyan |
| 5 | Dark Gray |
| 6 | Gray |
| 7 | Light Gray |
| 8 | Green |
| 9 | Magenta |
| 10 | Orange |
| 11 | Pink |
| 12 | Red |
| 13 | Yellow |
-
itemMarkColor:
integer
Integer value representing the color of the item Mark status background.Example:
0 -
itemRecallableColor:
integer
Integer value representing the color of the item Recallable status background.Example:
0 -
itemRecallColor:
integer
Integer value representing the color of the item Recall status background.Example:
0 -
itemSelectColor:
integer
Integer value representing the color of the item status background.Example:
0 -
statusBumpedColor:
integer
Integer value representing the color in which items appear when they are bumped from Prep Displays.Example:
0 -
statusFiredColor:
integer
Integer value representing the color in which items appear when they fire to Prep Displays.Example:
0 -
statusSentColor:
integer
Integer value representing the color in which items appear when workstation operators send orders to the KDS.Example:
0 -
statusStartedColor:
integer
Integer value representing the color in which items appear when they are Prep started.Example:
0
Nested Schema : layoutColorsOverride
Type:
objectAn object representing the layout colors override. Values can be specified either as hexadecimal color strings (ex '#FF5733') or as the names of known colors (ex, 'Red', 'Blue'). For a complete list of known color names, refer to the List Values section of the C&C API documentation.
Show Source
-
alert1:
string
Known color name or hexadecimal value representing the RBG combination of the background color for orders exceeding the first alert time.Example:
#0FF000 -
alert2:
string
Known color name or hexadecimal value representing the RBG combination of the background color for orders exceeding the second alert time.Example:
#0FF000 -
background:
string
Known color name or hexadecimal value representing the RBG combination of the background panel color for the KDS Display.Example:
#0FF000 -
course1Item:
string
Known color name or hexadecimal value representing the RBG combination of the color in which Course 1 items appear on the KDS.Example:
#0FF000 -
orderBackground:
string
Known color name or hexadecimal value representing the RBG combination of the background color for orders on the KDS Display.Example:
#0FF000 -
orderSelection:
string
Known color name or hexadecimal value representing the RBG combination of the color in which the border of an order appears when selecting an item.Example:
#0FF000 -
voidItem:
string
Known color name or hexadecimal value representing the RBG combination of the color in which voided items appear on the KDS.Example:
#0FF000
Nested Schema : name
Type:
objectName of the KDS Controller. Required for creating new object.
Example:
{
"1":"Enterprise",
"2":"Unternehmen",
"3":"Empresa"
}Nested Schema : svcHost
Type:
objectAn object representing the service host details associated with the KDS controller.
Show Source
-
svcHostObjNum:
integer
Unique Id of the service host associated with the KDS Controller.Example:
1
Response
Supported Media Types
- application/json
200 Response
Update operation executed successfully.
Root Schema : schema
Type:
Show Source
object-
hierUnitId:
integer
Unique hierarchy unit valueExample:
1 -
objectNum:
integer
Object number of the Kitchen Display ControllerExample:
1
201 Response
Insert operation executed successfully.
Root Schema : schema
Type:
Show Source
object-
hierUnitId:
integer
Unique hierarchy unit valueExample:
1 -
objectNum:
integer
Object number of the Kitchen Display ControllerExample:
1