Get Kitchen Display Controllers
post
/config/sim/v1/devices/getKitchenDisplayControllers
Gets all the KDS Controllers
Request
Supported Media Types
- application/json
- multipart/form-data
A request body
Root Schema : KDSControllerGetRequestBody
Type:
objectThe input Body model that needs to be given.
Show Source
-
include:
string
Objects included in 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 order device objects for the organization.
Root Schema : KDSControllers
Type:
objectModel for KDS Controllers object
Show Source
-
autoBumpCheckCount(required):
integer
The number of checks allowed to appear on the KDS before automatically bumping.Example:
0 -
autoBumpTimeInSecs(required):
integer
The wait time before automatically bumping all closed orders after reaching the Check Count.Example:
0 -
bckupSVCHost(required):
object bckupSVCHost
An object representing the backup service host details associated with the KDS controller.
-
controllerId(required):
integer
The KDS Controller ID for troubleshooting purposes. This is auto-generated when adding the KDS Controller and cannot be edited.Example:
1 -
dbUpdateFrequencyInSecs(required):
integer
The number of seconds the KDS Controller waits to retrieve updates from the database.Example:
0 -
displayLanguage(required):
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(required):
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(required):
integer
Indicator of where to show orders when they are recalled from an Expo or SOS Display.Example:
0 -
extPostingFile1(required):
string
File name and directory path for the text file where the KDS transaction information is stored.Example:
file1.txt -
extPostingFile2(required):
string
File name and directory path for the text file where the KDS transaction information is stored.Example:
file2.txt -
extPostingFile3(required):
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 -
hierUnitName(required):
object hierUnitName
Hierarchy unit name
-
hierUnitObjNum(required):
integer
Hierarchy unit object numberExample:
1 -
itemStatusColors(required):
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(required):
object layoutColorsOverride
An object representing the layout color override.
-
maxItemsPerZone(required):
integer
The maximum number of items that can be added to a zone.Example:
0 -
mediaViewerURL(required):
string
The URL of the IIS website where the Media Viewer is defined.Example:
https://viewer -
name(required):
name of the KDS ControllerExample:
{ "en-US":"Enterprise", "de-DE":"Unternehmen", "es-MX":"Empresa" } -
numberOfZones(required):
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(required):
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 -
optionsExt(required):
object optionsExt
An object containing the descriptive options list associated with the KDS Controller.
-
prodCountDecrementType(required):
integer
Indicator of when to decrease the count of items from the production counter.Example:
0 -
prodCountIncrementType(required):
integer
Indicator of when to add ordered items to the production counter.Example:
0 -
svcHost(required):
object svcHost
An object representing the service host details associated with the KDS controller.
-
waitForPrepSubOrderInSecs(required):
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
-
bckupSVCHostName:
object bckupSVCHostName
A group of strings representing the name of the backup service host associated with the KDS Controller.
-
bckupSVCHostObjNum:
integer
Object number of the backup service host associated with the KDS Controller.Example:
1 -
num:
integer
Unique number of the backup service host. This value is read-only and cannot be added or modified.Example:
59421 -
port:
integer
The port number for each service on the selected service host.Example:
8080 -
record:
integer
The object number and name of the service record. For example, if a workstation, KDS Controller, and credit card driver are all running on the same Service Host, this column shows their object numbers and names. This value is read-only and cannot be added or modified.Example:
1-1 -
totalsCleardThrough:
string
Totals on this workstation were cleared up to this datestamp. This value is read-only and cannot be added or modified.Example:
2020-12-12T12:00:00 -
url:
string
The URL of the service for informational purposes only. It is used when constructing the full path to connect to the service. For example, Simphony services are connected using a path such as http://ServiceHostName:Port/URL. This value is read-only and cannot be added or modified.Example:
EGateway/EGateway.aspx
Nested Schema : hierUnitName
Type:
objectHierarchy unit name
Example:
{
"en-US":"Enterprise",
"de-DE":"Unternehmen",
"es-MX":"Empresa"
}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 : optionsExt
Type:
objectAn object containing the descriptive options list associated with the KDS Controller.
Show Source
-
displayNextCourseAfterPrevCourseComplete:
boolean
A Boolean flag indicating to show menu items from Course 2 on KDS Displays only after menu items from Course 1 are bumped when using dining courses.Example:
false -
enableBackUpControllerAutoTakeover:
boolean
A Boolean flag indicating to allow the backup KDS Controller to take over automatically when the primary controller is down if a Backup Service Host is configured for the KDS Controller.Example:
false -
enableCapacityScheduling:
boolean
A Boolean flag indicating to display orders in the kitchen based on prep station capacity with the goal of having all items prep complete at the same time. Note that Capacity and Capacity Usage need to be defined. This option cannot be used with DOM and requires Single Item Per Sub Order to be enabled.Example:
false -
enableItemStartedTimings:
boolean
A Boolean flag indicating to recalculate an order???s target done time (TDT) when the item with the longest prep time is started for non-DOM KDS systems.Example:
false -
enableLoadBalancing:
boolean
A Boolean flag indicating to dynamically distribute incoming items/orders between preconfigured group(s) of prep or expo stations based on the current load of un-bumped items or orders.Example:
false -
excludeCALUpdatesFromSVCHost:
boolean
A Boolean flag indicating to exclude updates to CAL for Service Host changes made in the KDS Controller if the property does not use CAL.Example:
false -
expoOnlyItemsDisplayAsDone:
boolean
A Boolean flag indicating to change the status of menu items that do not go to Prep Stations to Done when they fire.Example:
false -
includeThemeInDeviceName:
boolean
A Boolean flag indicating to have the KDS show the current Kitchen Theme after the device name on the KDS status bar.Example:
false -
preventBumpWhileOrdering:
boolean
A Boolean flag indicating to prevent bumping of items or orders and to have the chits show as ordering on the KDS in revenue centers with DOM enabled. Only applies when transactions are in progress.Example:
false -
preventChitBumpOnExpoIfExistOnPrep:
boolean
A Boolean flag indicating to prevent a chit from being bumped on an Expo Display if the chit exists on a Prep Display.Example:
false -
recallToOrgPosition:
boolean
A Boolean flag indicating to show recalled orders in their original position prior to being bumped. Deselect to show recalled orders ahead of existing orders.Example:
false -
showOnlyActiveOrders:
boolean
A Boolean flag indicating to allow SOS Displays to show only tables with open orders.Example:
false -
startHideOtherPreps:
boolean
A Boolean flag indicating to have orders disappear from all other KDS Prep Stations when an order chit is marked as started.Example:
false
Nested Schema : svcHost
Type:
objectAn object representing the service host details associated with the KDS controller.
Show Source
-
num:
integer
Unique number of the service host. This value is read-only and cannot be added or modified.Example:
59421 -
port:
integer
The port number for each service on the selected service host.Example:
8080 -
record:
integer
The object number and name of the service record. For example, if a workstation, KDS Controller, and credit card driver are all running on the same Service Host, this column shows their object numbers and names. This value is read-only and cannot be added or modified.Example:
1-1 -
svcHostName:
object svcHostName
A group of strings representing the name of the service host associated with the KDS controller.
-
svcHostObjNum:
integer
Object number of the service host associated with the KDS Controller.Example:
1 -
totalsCleardThrough:
string
Totals on this workstation were cleared up to this datestamp. This value is read-only and cannot be added or modified.Example:
2020-12-12T12:00:00 -
url:
string
The URL of the service for informational purposes only. It is used when constructing the full path to connect to the service. For example, Simphony services are connected using a path such as http://ServiceHostName:Port/URL. This value is read-only and cannot be added or modified.Example:
EGateway/EGateway.aspx
Nested Schema : bckupSVCHostName
Type:
objectA group of strings representing the name of the backup service host associated with the KDS Controller.
Example:
{
"en-US":"Enterprise",
"de-DE":"Unternehmen",
"es-MX":"Empresa"
}Nested Schema : svcHostName
Type:
objectA group of strings representing the name of the service host associated with the KDS controller.
Example:
{
"en-US":"Enterprise",
"de-DE":"Unternehmen",
"es-MX":"Empresa"
}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