Get Kitchen Display Clients
post
/config/sim/v1/devices/getKitchenDisplays
Gets all the KDS Displays
Request
Supported Media Types
- application/json
A request body
Root Schema : KDSGetRequestBody
Type:
objectThe input Body model that needs to be given.
Show Source
-
include:
string
Objects included in the response.
-
includeAll:
string
This can take 2 values: basic or detailed. If 'basic' is specified, The response contains all the properties of the object except
Ext values. If 'detailed' is specified, The response contains all the properties of the object. Example:detailed -
languages:
string
If specified, limits the translated strings returned.
-
limit:
integer
If using paging, number of results returned in this page.
-
offset:
integer
Starting resource record index. Not required if paging parameters are not supported.
-
orderBy:
string
Sorts the response by the specified field name and sort order.
-
searchCriteria:
string
Search criteria to filter results based on field value.
Response
Supported Media Types
- application/json
200 Response
A collection of KDS Displays entities in an organization.
Root Schema : KDSDisplays
Type:
objectModel for KDS Displays Object.
Show Source
-
bumpBarName(required):
object bumpBarName
A group of string objects representing the name of the Bump Bar to use for the display in configured languages.
-
bumpBarObjNum(required):
integer
Object number of the bump bar to use for the display.Example:
1 -
cardId(required):
integer
The slot number or position of the SEI card in the OASYS box. Applicable only if platformType = 1Example:
1 -
comboItemFont(required):
integer
The font size for the Combo Items as they should appear on the KDS Display.Example:
1 -
displayOrientation(required):
integer
The orientation type for the display.Example:
1 -
displayType(required):
integer
An integer value representing the type of the display.Example:
1 -
hierUnitId(required):
integer
Unique reference of the hierarchy unit.Example:
1 -
hierUnitName(required):
object hierUnitName
Additional Properties Allowed: additionalPropertiesA group of string objects representing the name of the hierarchy unit configured languages.
-
hierUnitObjNum(required):
integer
Object number of the hierarchy unit.Example:
1 -
ipAddress(required):
string
The IP address for the display.Example:
0.0.0.0 -
kdsChitLayoutStyleName(required):
integer
A group of string objects representing the name of the chit layout type for the display in configured languages.Example:
1 -
kdsChitLayoutStyleObjNum(required):
integer
Object number of the chit layout type for the display.Example:
1 -
kdsControllerName(required):
integer
A group of string objects representing the name of the KDS controller for the display in configured languages.Example:
1 -
kdsControllerObjNum(required):
integer
Object number of the KDS controller for the display.Example:
1 -
kdsProdColumns(required):
integer
The maximum number of production item counters to show per line or production bar.Example:
1 -
kdsProdLocation(required):
integer
The placement of production item counters on the display. 1 ??? Top 2- BottomExample:
1 -
locationFromLeft(required):
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(required):
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(required): integer
-
name(required):
object name
Additional Properties Allowed: additionalPropertiesA 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(required):
string
A string value of 0s & 1s of length 32 representing the enablement or disablement of the options associated with the KDS DisplayExample:
00000011000000000000000000000000 -
optionsExt(required):
object optionsExt
An object containing the descriptive options list associated with the KDS Display.
-
orderSelectionTimeInSecs(required):
integer
The amount of time in seconds an order remains selected on the display.Example:
1 -
orderTypeFont(required):
integer
The font size for the Order Type text to appear on the display.Example:
1 -
panelConfiguration(required):
array panelConfiguration
An array of configurations for the different panel definitions of the Display. Applicable only if displayType = 2 or 3
-
panelLayout(required):
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(required):
integer
The platform type of the display.Example:
1 -
prodItems(required):
array prodItems
An array of production items.
-
recallReviewList(required):
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(required):
integer
The height (in pixels) used to display KDS in a side-by-side (split window) display.Example:
1 -
resolutionWidth(required):
integer
The width (in pixels) used to display KDS in a side-by-side (split window) display.Example:
1 -
serpentineMode(required):
integer
A value representing the arrangement of chits on the display.Example:
1 -
sosDisplayTableColumns(required):
integer
The number of columns to use to present table numbers for the SOS Table Display. Applicable only if displayType = 1Example:
1 -
sosDisplayTimeout(required):
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(required):
integer
The SOS sort method for the display. Use the Width fields to determine how each column appears.Example:
1 -
sosZoneFont(required):
integer
The font size for SOS zones to appear on the display. Applicable only if displayType = 1Example:
1 -
tableDetailToolbarName(required):
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(required):
integer
Object number of the toolbar to use when viewing Table Details on a SOS Display.Example:
1 -
toolbarName(required):
object toolbarName
A group of string objects representing the name of the toolbar to use for the display in configured languages.
-
toolbarObjNum(required):
integer
Object number of the toolbar to use for the display.Example:
1 -
toolBarPosition(required):
integer
An integer value representing the location for the toolbar on the display.Example:
1 -
videoId(required):
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",
"de-DE":"Unternehmen",
"es-MX":"Empresa"
}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",
"de-DE":"Unternehmen",
"es-MX":"Empresa"
}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",
"de-DE":"Unternehmen",
"es-MX":"Empresa"
}Nested Schema : optionsExt
Type:
objectAn object containing the descriptive options list associated with the KDS Display.
Show Source
-
allowHideFrame:
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:
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:
integer
A Boolean flag indicating to allow other KDS Displays to remotely view orders on this display.Example:
1 -
displayItemDoubleTouchBump:
integer
A Boolean flag indicating to prevent kitchen staff from bumping items from KDS Displays using double touch.Example:
1 -
displayRVCSeparator:
integer
A Boolean flag indicating to separate orders by revenue center when SOS and Dynamic Displays are enabled.Example:
1 -
displayZone:
integer
A Boolean flag indicating to show zones when SOS and Dynamic Displays are enabled.Example:
1 -
dynamicDisplays:
integer
A Boolean flag indicating to Select to enable Dynamic Display on an SOS Display.Example:
1 -
enableItemSelect:
integer
A Boolean flag indicating to allow kitchen staff to select items on the chit.Example:
1 -
onlyActiveTables:
integer
A Boolean flag indicating to show only tables that are currently active on the SOS Display.Example:
1 -
resetKDSChitTimer:
integer
A Boolean flag indicating to have the KDS chit timer reset on the first service total.Example:
1 -
showMouseCursor:
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",
"de-DE":"Unternehmen",
"es-MX":"Empresa"
}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 -
prodItemName:
integer
A group of strings representing the name of the production items in configured languages.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
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
404 Response
404 Requested resource not found
Examples
Example Request Body
The following example shows the contents of the request body in JSON format:
{
"searchCriteria" : "",
"languages" : "",
"limit" : 100,
"offset" : 0,
"orderBy": "",
"include": ""
}Example Response Body
The following example shows the contents of the response body in JSON format:
{
"totalResults": 1,
"hasMore": false,
"count": 1,
"items": [
{
"hierUnitId": 1763,
"hierUnitObjNum": 1,
"hierUnitName": {
"en-US": "Nick Q1"
},
"kdsControllerObjNum": 0,
"toolBarObjNum": 0,
"bumpBarObjNum": 0,
"platformType": 0,
"cardId": 0,
"videoId": 0,
"displayOrientation": 0,
"orderSelectionTimeInSecs": 0,
"options": "00000011000000000000000000000000",
"displayType": 1,
"toolBarPosition": 0,
"panelLayout": 0,
"tableDetailToolbarObjNum": 0,
"panelConfiguration": [
{
"panelNum": 1,
"proportion": 1,
"chitColumns": 1,
"chitRows": 0,
"capacity": 0
}
],
"kdsChitLayoutStyleObjNum": 101,
"serpentineMode": 0,
"menuItemFont": 8,
"comboItemFont": 8,
"orderTypeFont": 8,
"sosDisplayTableColumns": 8,
"sosDisplayTimeout": 0,
"sosZoneFont": 8,
"sosSortMethod": 0,
"minTableState": 0,
"maxTableState": 0,
"recallReviewList": [
{
"colNum": 1,
"colType": 0,
"width": 0
},
{
"colNum": 2,
"colType": 0,
"width": 0
},
{
"colNum": 3,
"colType": 0,
"width": 0
},
{
"colNum": 4,
"colType": 0,
"width": 0
},
{
"colNum": 5,
"colType": 0,
"width": 0
},
{
"colNum": 6,
"colType": 0,
"width": 0
}
],
"kdsProdLocation": 1,
"kdsProdColumns": 0,
"resolutionWidth": 0,
"resolutionHeight": 0,
"locationFromTop": 0,
"locationFromLeft": 0,
"objectNum": 1,
"name": {
"en-US": "1"
}
}
],
"limit": 10,
"offset": 0
}