Add Kitchen Display Clients
post
/config/sim/v1/devices/KitchenDisplays
Add the KDS Displays object to a specified hierarchy unit of the specified organization.
Request
Supported Media Types
- application/json
- multipart/form-data
Header Parameters
-
Simphony-AuditTrailRef(optional): string(string)
Detail that identifies who made the change.
-
Simphony-OrgShortName: string(string)
Org Identifier
KDS Displays object of the organization.
Root Schema : KDSDisplays
Type:
objectModel for KDS Displays Object.
Show Source
-
bumpBarName(optional):
object bumpBarName
A group of string objects representing the name of the Bump Bar to use for the display in configured languages.
-
bumpBarObjNum(optional):
integer
Object number of the bump bar to use for the display.Example:
1 -
cardId(optional):
integer
The slot number or position of the SEI card in the OASYS box. Applicable only if platformType = 1Example:
1 -
comboItemFont(optional):
integer
The font size for the Combo Items as they should appear on the KDS Display.Example:
1 -
displayOrientation(optional):
integer
The orientation type for the display.Example:
1 -
displayType(optional):
integer
An integer value representing the type of the display.Example:
1 -
hierUnitId:
integer
Unique reference of the hierarchy unit.Example:
1 -
hierUnitName(optional):
object hierUnitName
Additional Properties Allowed: additionalPropertiesA group of string objects representing the name of the hierarchy unit configured languages.
-
hierUnitObjNum(optional):
integer
Object number of the hierarchy unit.Example:
1 -
ipAddress(optional):
integer
The IP address for the display.Example:
1 -
kdsChitLayoutStyleName(optional):
integer
A group of string objects representing the name of the chit layout type for the display in configured languages.Example:
1 -
kdsChitLayoutStyleObjNum(optional):
integer
Object number of the chit layout type for the display.Example:
1 -
kdsControllerName(optional):
integer
A group of string objects representing the name of the KDS controller for the display in configured languages.Example:
1 -
kdsControllerObjNum(optional):
integer
Object number of the KDS controller for the display.Example:
1 -
kdsProdColumns(optional):
integer
The maximum number of production item counters to show per line or production bar.Example:
1 -
kdsProdLocation(optional):
integer
The placement of production item counters on the display. 1 ??? Top 2- BottomExample:
1 -
locationFromLeft(optional):
integer
A value representing how far from the left (in pixels) the KDS window should be placed on the workstation display screen.Example:
1 -
locationFromTop(optional):
integer
A value representing how far from the top (in pixels) the KDS window should be placed on the workstation display screen.Example:
1 - menuItemFont(optional): integer
-
name:
object name
Additional Properties Allowed: additionalPropertiesA group of string objects representing the name of the KDS Display in configured languages.
-
objectNum:
integer
Object number of the KDS Display.Example:
1 -
options(optional):
integer
A string value of 0???s & 1???s representing the enablement or disablement of the options associated with the KDS DisplayExample:
1 -
optionsExt(optional):
object optionsExt
An object containing the descriptive options list associated with the KDS Display.
-
orderSelectionTimeInSecs(optional):
integer
The amount of time in seconds an order remains selected on the display.Example:
1 -
orderTypeFont(optional):
integer
The font size for the Order Type text to appear on the display.Example:
1 -
panelConfiguration(optional):
array panelConfiguration
An array of configurations for the different panel definitions of the Display. Applicable only if displayType = 2 or 3
-
panelLayout(optional):
integer
If the display has two panels, select whether the panels appear side-by-side or one on top of the other. Applicable only if displayType = 2 or 3Example:
1 -
platformType(optional):
integer
The platform type of the display.Example:
1 -
prodItems(optional):
array prodItems
An array of production items.
-
recallReviewList(optional):
array recallReviewList
An array of column configurations to display on the KDS Recall/ Review List. Configuration is allowed for up to 6 columns. Use the Column Type to select the detail types from the following preset 9 choices. 0 ??? None. 1- Check . 2 ??? Table. 3 ??? Revenue Center. 4 ??? Done Time. 5 ??? Done Time Elapsed. 6 ??? Order Time Elapsed. 7 ??? Server. 8 ??? Order Type. 9 - Items. Use the Width fields to determine how each column appears.
-
resolutionHeight(optional):
integer
The height (in pixels) used to display KDS in a side-by-side (split window) display.Example:
1 -
resolutionWidth(optional):
integer
The width (in pixels) used to display KDS in a side-by-side (split window) display.Example:
1 -
serpentineMode(optional):
integer
A value representing the arrangement of chits on the display.Example:
1 -
sosDisplayTableColumns(optional):
integer
The number of columns to use to present table numbers for the SOS Table Display. Applicable only if displayType = 1Example:
1 -
sosDisplayTimeout(optional):
integer
The duration that a table appears on the regular Expo Display screen before returning to the SOS Table Display. Applicable only if displayType = 1Example:
1 -
sosSortMethod(optional):
integer
The SOS sort method for the display. Use the Width fields to determine how each column appears.Example:
1 -
sosZoneFont(optional):
integer
The font size for SOS zones to appear on the display. Applicable only if displayType = 1Example:
1 -
tableDetailToolbarName(optional):
integer
A group of string objects representing the name of the toolbar to use when viewing Table Details on a SOS Display in configured languages.Example:
1 -
tableDetailToolbarObjNum(optional):
integer
Object number of the toolbar to use when viewing Table Details on a SOS Display.Example:
1 -
toolbarName(optional):
object toolbarName
A group of string objects representing the name of the toolbar to use for the display in configured languages.
-
toolbarObjNum(optional):
integer
Object number of the toolbar to use for the display.Example:
1 -
toolBarPosition(optional):
integer
An integer value representing the location for the toolbar on the display.Example:
1 -
videoId(optional):
integer
An ID to identify the display in the system. Applicable only if platformType = 1Example:
1
Nested Schema : bumpBarName
Type:
objectA group of string objects representing the name of the Bump Bar to use for the display in configured languages.
Example:
{
"en-US":"Enterprise",
"es-SS":"Empresa",
"lt=LT":"??mon??"
}Nested Schema : hierUnitName
Type:
objectAdditional Properties Allowed
Show Source
A group of string objects representing the name of the hierarchy unit configured languages.
Example:
{
"en-US":"Enterprise",
"es-SS":"Empresa",
"lt=LT":"??mon??"
}Nested Schema : name
Type:
objectAdditional Properties Allowed
Show Source
A group of string objects representing the name of the KDS Display in configured languages.
Example:
{
"en-US":"Enterprise",
"es-SS":"Empresa",
"lt=LT":"??mon??"
}Nested Schema : optionsExt
Type:
objectAn object containing the descriptive options list associated with the KDS Display.
Show Source
-
allowHideFrame(optional):
integer
A Boolean flag indicating to hide the KDS Display window frame when the KDS Display UI is not in full-screen mode.Example:
1 -
allowRemoteActions(optional):
integer
A Boolean flag indicating to allow other KDS Displays to perform Done, Recall, and Review actions on this KDS Display while in Remote View.Example:
1 -
allowRemoteView(optional):
integer
A Boolean flag indicating to allow other KDS Displays to remotely view orders on this display.Example:
1 -
displayItemDoubleTouchBump(optional):
integer
A Boolean flag indicating to prevent kitchen staff from bumping items from KDS Displays using double touch.Example:
1 -
displayRVCSeparator(optional):
integer
A Boolean flag indicating to separate orders by revenue center when SOS and Dynamic Displays are enabled.Example:
1 -
displayZone(optional):
integer
A Boolean flag indicating to show zones when SOS and Dynamic Displays are enabled.Example:
1 -
dynamicDisplays(optional):
integer
A Boolean flag indicating to Select to enable Dynamic Display on an SOS Display.Example:
1 -
enableItemSelect(optional):
integer
A Boolean flag indicating to allow kitchen staff to select items on the chit.Example:
1 -
onlyActiveTables(optional):
integer
A Boolean flag indicating to show only tables that are currently active on the SOS Display.Example:
1 -
resetKDSChitTimer(optional):
integer
A Boolean flag indicating to have the KDS chit timer reset on the first service total.Example:
1 -
showMouseCursor(optional):
integer
A Boolean flag indicating to make the cursor visible on the KDS display.Example:
1
Nested Schema : panelConfiguration
Type:
arrayAn array of configurations for the different panel definitions of the Display. Applicable only if displayType = 2 or 3
Show Source
Nested Schema : recallReviewList
Type:
arrayAn array of column configurations to display on the KDS Recall/ Review List. Configuration is allowed for up to 6 columns. Use the Column Type to select the detail types from the following preset 9 choices. 0 ??? None. 1- Check . 2 ??? Table. 3 ??? Revenue Center. 4 ??? Done Time. 5 ??? Done Time Elapsed. 6 ??? Order Time Elapsed. 7 ??? Server. 8 ??? Order Type. 9 - Items. Use the Width fields to determine how each column appears.
Show Source
Nested Schema : toolbarName
Type:
objectA group of string objects representing the name of the toolbar to use for the display in configured languages.
Example:
{
"en-US":"Enterprise",
"es-SS":"Empresa",
"lt=LT":"??mon??"
}Nested Schema : items
Type:
Show Source
object-
capacity(optional):
integer
The relative capacity of the order devices linked to this panel. This field should only be used with KDS Controllers | General | Options | 13 ??? Enable Capacity Scheduling.Example:
1 -
chitColumns(optional):
integer
The number of chit columns to display in the panel.Example:
1 -
chitRows(optional):
integer
The number of chit rows to display in the panel.Example:
1 -
panelNum(optional):
integer
The number of panels to show on the KDS Display.Example:
1 -
proportion(optional):
integer
The ratio for the panel to occupy on the KDS Display.Example:
1
Nested Schema : items
Type:
Show Source
object-
persistence(optional):
integer
An integer value representing the persistence type of the item on the display. 1 ??? Static. Shows counts on KDS displays even when the quantity is zero. 2 ??? Dynamic. Shows counts on KDS displays only for a non-zero quantity.Example:
1 -
prodItemName(optional):
integer
A group of strings representing the name of the production items in configured languages.Example:
1 -
prodItemNum(optional):
integer
Sequence number of the production item.Example:
1 -
prodItemObjNum(optional):
integer
Object number of the production item.Example:
1
Nested Schema : items
Type:
Show Source
object-
colNum(optional):
integer
The column number of the recall/review list.Example:
1 -
colType(optional):
integer
The column type from the preset 9 choices.Example:
1 -
width(optional):
integer
The column width relative to the total screen width.Example:
1
Response
Supported Media Types
- application/json
200 Response
KDS Displays object to a specified hierarchy unit of the specified organization.
Root Schema : KDS
Type:
Show Source
object-
hierUnitId:
integer
Unique hierarchy unit value.Example:
1 -
objectNum:
integer
Object number of the printer.Example:
1
400 Response
400 Bad Request
Root Schema : ErrorDetails
Type:
objectResponse body when the request returns an error.
Show Source
-
detail(optional):
string
A short, human-readable summary of the problem.Example:
Specified Data is invalid -
errorDetails(optional):
string
A human-readable explanation specific to this occurrence of the problem.Example:
Entity Does Not Exist -
o:errorCode(optional):
integer
Error code of the problemExample:
55223 -
status(optional):
integer
HTTP status code.Example:
400 -
title(optional):
string
A short, human-readable summary of the problem type.Example:
VALIDATION ERROR -
type(optional):
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