Add Kitchen Display Controllers
post
/config/sim/v2/devices/kitchenDisplayControllers
Add a KDS Controllers record for the current organization.
Request
Supported Media Types
- application/json
- multipart/form-data
Header Parameters
-
Simphony-AuditTrailRef: string(string)
Detail that identifies who made the change.
A request body
Root Schema : KDSControllersCUDRequestBodyv2
Type:
objectModel for KDS Controllers CUD 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.
-
controllerId:
integer
The KDS Controller ID for troubleshooting purposes. This is auto-generated when adding the KDS Controller and cannot be edited.Example:
1 -
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 as per the below mapping. 0 ??? Default 1 ??? Black 2 ??? White 3 ??? Blue 4 ??? Cyan5 ??? 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 color override.
-
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(required):
object name
name of the KDS Controller
-
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 64 representing the enablement or disablement of the options associated with the KDS Controller.Example:
0000000000000000000000000000000000000000000000000000000000000000 -
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
Object number 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 as per the below mapping. 0 ??? Default 1 ??? Black 2 ??? White 3 ??? Blue 4 ??? Cyan5 ??? Dark Gray 6 ??? Gray 7 ??? Light Gray 8 ??? Green 9 ??? Magenta 10 ??? Orange 11 ??? Pink 12 ??? Red 13 ??? Yellow
Show Source
-
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 color override.
Show Source
-
alert1:
string
Hexadecimal value representing the RBG combination of the background color for orders exceeding the first alert time.Example:
000000 -
alert2:
string
Hexadecimal value representing the RBG combination of the background color for orders exceeding the second alert time.Example:
000000 -
background:
string
Hexadecimal value representing the RBG combination of the background panel color for the KDS Display.Example:
000000 -
course1Item:
string
Hexadecimal value representing the RBG combination of the color in which Course 1 items appear on the KDS.Example:
000000 -
orderBackground:
string
Hexadecimal value representing the RBG combination of the background color for orders on the KDS Display.Example:
000000 -
orderSelection:
string
Hexadecimal value representing the RBG combination of the color in which the border of an order appears when selecting an item.Example:
000000 -
voidItem:
string
Hexadecimal value representing the RBG combination of the color in which voided items appear on the KDS.Example:
000000
Nested Schema : name
Type:
objectname of the KDS Controller
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
Object number of the service host associated with the KDS Controller.Example:
1
Response
Supported Media Types
- application/json
200 Response
The KDS Controller added
Root Schema : KDSController
Type:
Show Source
object-
hierUnitId(required):
integer
Unique hierarchy unit valueExample:
1 -
objectNum(required):
integer
Object number of the printerExample:
1
400 Response
400 Bad Request
Root Schema : ErrorDetails
Type:
objectResponse body when the request returns an error.
Show Source
-
detail(required):
string
A short, human-readable summary of the problem.Example:
Specified Data is invalid -
errorDetails(required):
string
A human-readable explanation specific to this occurrence of the problem.Example:
Entity Does Not Exist -
o:errorCode(required):
integer
Error code of the problemExample:
55223 -
status(required):
integer
HTTP status code.Example:
400 -
title(required):
string
A short, human-readable summary of the problem type.Example:
VALIDATION ERROR -
type(required):
string
A URI reference that identifies the problem type. When this member is not present, its value is assumed to be "about:blank".Example:
http://www.abc.org/xyz.html