Add Kitchen Display Clients
post
/config/sim/v2/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: string
Detail that identifies, who made the change.
KDS Displays CUD Request Body
Root Schema : schema
Type:
objectModel for KDS Displays CUD Request.
Show Source
-
bumpBarObjNum:
integer
Object number of the bump bar to use for the display.Example:
1 -
cardId:
integer
The slot number or position of the SEI card in the OASYS box. Applicable only if platformType = 1Example:
1 -
comboItemFont:
integer
The font size for the Combo Items as they should appear on the KDS Display.Example:
1 -
displayOrientation:
integer
The orientation type for the display.Example:
1 -
displayType:
integer
An integer value representing the type of the display.Example:
1 -
hierUnitId(required):
integer
Unique reference of the hierarchy unit.Example:
1 -
ipAddress:
string
The IP address for the display.Example:
0.0.0.0 -
kdsChitLayoutStyleObjNum:
integer
Object number of the chit layout type for the display.Example:
1 -
kdsControllerObjNum:
integer
Object number of the KDS controller for the display.Example:
1 -
kdsProdColumns:
integer
The maximum number of production item counters to show per line or production bar.Example:
1 -
kdsProdLocation:
integer
The placement of production item counters on the display. 1 - Top, 2 - BottomExample:
1 -
locationFromLeft:
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:
integer
A value representing how far from the top (in pixels) the KDS window should be placed on the workstation display screen.Example:
1 -
maxTableState:
integer
Maximum Table StateExample:
1 - menuItemFont: integer
-
minTableState:
integer
Minimum Table StateExample:
0 -
name(required):
object name
A group of string objects representing the name of the KDS Display in configured languages.
-
objectNum(required):
integer
Object number of the KDS Display.Example:
1 -
options:
string
A string value of 0s & 1s of length 32 representing the enablement or disablement of the options associated with the KDS DisplayExample:
00000011000000000000000000000000 -
orderSelectionTimeInSecs:
integer
The amount of time in seconds an order remains selected on the display.Example:
1 -
orderTypeFont:
integer
The font size for the Order Type text to appear on the display.Example:
1 -
panelConfiguration:
array panelConfiguration
An array of configurations for the different panel definitions of the Display. Applicable only if displayType = 2 or 3
-
panelLayout:
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:
integer
The platform type of the display.Example:
1 -
prodItems:
array prodItems
An array of production items.
-
recallReviewList:
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:
integer
The height (in pixels) used to display KDS in a side-by-side (split window) display.Example:
1 -
resolutionWidth:
integer
The width (in pixels) used to display KDS in a side-by-side (split window) display.Example:
1 -
serpentineMode:
integer
A value representing the arrangement of chits on the display.Example:
1 -
sosDisplayTableColumns:
integer
The number of columns to use to present table numbers for the SOS Table Display. Applicable only if displayType = 1Example:
1 -
sosDisplayTimeout:
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:
integer
The SOS sort method for the display. Use the Width fields to determine how each column appears.Example:
1 -
sosZoneFont:
integer
The font size for SOS zones to appear on the display. Applicable only if displayType = 1Example:
1 -
tableDetailToolbarObjNum:
integer
Object number of the toolbar to use when viewing Table Details on a SOS Display.Example:
1 -
toolbarObjNum:
integer
Object number of the toolbar to use for the display.Example:
1 -
toolBarPosition:
integer
An integer value representing the location for the toolbar on the display.Example:
1 -
videoId:
integer
An ID to identify the display in the system. Applicable only if platformType = 1Example:
1
Nested Schema : name
Type:
objectA group of string objects representing the name of the KDS Display in configured languages.
Example:
{
"1":"Enterprise",
"2":"Unternehmen",
"3":"Empresa"
}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.
Nested Schema : items
Type:
Show Source
object-
capacity:
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:
integer
The number of chit columns to display in the panel.Example:
1 -
chitRows:
integer
The number of chit rows to display in the panel.Example:
1 -
panelNum:
integer
The number of panels to show on the KDS Display.Example:
1 -
proportion:
integer
The ratio for the panel to occupy on the KDS Display.Example:
1
Nested Schema : items
Type:
Show Source
object-
persistence:
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 -
prodItemNum:
integer
Sequence number of the production item.Example:
1 -
prodItemObjNum:
integer
Object number of the production item.Example:
1
Nested Schema : items
Type:
Show Source
object-
colNum:
integer
The column number of the recall/review list.Example:
1 -
colType:
integer
The column type from the preset 9 choices.Example:
1 -
width:
integer
The column width relative to the total screen width.Example:
1
Response
Supported Media Types
- application/json
200 Response
The Kitchen Display Client added.
Root Schema : schema
Type:
Show Source
object-
hierUnitId:
integer
Unique hierarchy unit value.Example:
1 -
objectNum:
integer
Object number of the Kitchen Display Client.Example:
1