Get Kitchen Themes
post
/config/sim/v2/setup/getKitchenThemes
Gets Kitchen Themes
Request
Supported Media Types
- multipart/form-data
- application/json
The input body model that needs to be given.
Root Schema : schema
Type:
Show Source
object-
include:
string
If specified, limits the data returned to these fields.Example:
hierUnitId, objectNum, name, rvcTypeOptions, workstations, kdsClients, orderDevices, orderTypes -
includeAll:
string
If this value is specified, the include parameter is ignored.
Value Description basic Forces the response to include all fields except option string details detailed Forces the response to include all fields including option string details Example:detailed -
langIds:
string
If specified, limits translated strings returnedExample:
263,302 -
limit:
integer
If using paging, number of results returned in this page.Example:
100 -
offset:
integer
Starting resource record index.Example:
0 -
orderBy:
string
Sorts the response by the specified field name and sort order. Allowed fields are objectNum, hierUnitId, name, and rvcTypeOptions.Example:
objectNum:asc -
searchCriteria:
string
If specified, returns records that match the criteria. Search criteria is supported for objectNum, hierUnitId, name, and rvcTypeOptions.Example:
where equals(objectNum, 973900)
Response
Supported Media Types
- application/json
200 Response
A collection of Kitchen Themes.
Root Schema : schema
Type:
Show Source
object-
count:
integer
Current response record count.Example:
10 -
hasMore:
boolean
Flag indicating if there are more objects to fetch.Example:
true -
items:
array items
Array of Kitchen Theme objects.
-
limit:
integer
Server page sizeExample:
10 -
offset:
integer
Starting resource record indexExample:
0 -
totalResults:
integer
Total number of rowsExample:
100
Nested Schema : items
Type:
arrayArray of Kitchen Theme objects.
Show Source
-
Array of:
object KitchenTheme
Kitchen Theme record
Nested Schema : KitchenTheme
Type:
objectKitchen Theme record
Show Source
-
hierUnitId:
integer
Unique hierarchy unit value.Example:
10088 -
kdsClients:
array kdsClients
-
name:
object name
A group of string objects representing the name of the Kitchen Theme in configured languages.
-
objectNum:
integer
Minimum Value:
1Maximum Value:999999999Object number of the Kitchen Theme.Example:973900 -
orderDevices:
array orderDevices
Order device records linked to the Kitchen Theme. KDS settings, KDS options, links, associations, and primaryDistributionGroup apply only when ordDeviceType is 1 and primaryDeviceType is 1.
-
orderTypes:
array orderTypes
-
rvcTypeOptions:
string
Minimum Length:
32Maximum Length:3232-character RVC type option mask.Example:10000000000000000000000000000000 -
workstations:
array workstations
Nested Schema : name
Type:
objectA group of string objects representing the name of the Kitchen Theme in configured languages.
Example:
{
"263":"API KT 3",
"302":"API KT 3 FR"
}Nested Schema : orderDevices
Type:
arrayOrder device records linked to the Kitchen Theme. KDS settings, KDS options, links, associations, and primaryDistributionGroup apply only when ordDeviceType is 1 and primaryDeviceType is 1.
Show Source
Nested Schema : items
Type:
Show Source
object-
bumpBar:
integer
Minimum Value:
0Maximum Value:999999999Example:1 -
objectNum(required):
integer
Minimum Value:
1Maximum Value:999999999Object number of the KDS client.Example:100 -
panelConfiguration:
array panelConfiguration
Maximum Number of Items:
9 -
panelLayout:
integer
Minimum Value:
0Maximum Value:2Example:0 -
serpentineMode:
integer
Minimum Value:
0Maximum Value:2Example:0 -
statusBar:
integer
Minimum Value:
0Maximum Value:999999999Example:0 -
toolBar:
integer
Minimum Value:
0Maximum Value:999999999Example:1
Nested Schema : items
Type:
Show Source
object-
capacity:
integer
Minimum Value:
0Maximum Value:999Example:0 -
chitColumns:
integer
Minimum Value:
1Maximum Value:9Example:1 -
chitRows:
integer
Minimum Value:
0Maximum Value:9Example:0 -
panelNum:
integer
Minimum Value:
1Maximum Value:9Example:1 -
proportion:
integer
Minimum Value:
0Maximum Value:99Example:1
Nested Schema : items
Type:
Show Source
object-
associations:
array associations
-
backupDevice:
integer
Minimum Value:
0Maximum Value:999999999Example:1 -
condimentSortType:
integer
Minimum Value:
0Maximum Value:2Example:1 -
device:
integer
Minimum Value:
0Maximum Value:999999999Example:100 -
kdsOptions:
string
Minimum Length:
48Maximum Length:4848-character KDS option mask. Options 1 and 3, 7 and 23, and 28 and 35 cannot be selected together. Option 32 requires option 3; options 33 and 34 require option 32.Example:100000000000001000000000000000000000000000000000 -
kdsSettings:
object kdsSettings
-
links:
array links
-
ordDeviceIndex(required):
integer
Minimum Value:
1Maximum Value:32Example:1 -
ordDeviceType:
integer
Minimum Value:
1Maximum Value:2Example:1 -
orderDeviceRedirect:
integer
Minimum Value:
0Maximum Value:32Example:2 -
primaryDeviceType:
integer
Minimum Value:
0Maximum Value:1Example:1 -
primaryDistributionGroup:
integer
Minimum Value:
0Maximum Value:32Example:0 -
rvcHierUnitId(required):
integer
Unique hierarchy unit value of the revenue center.Example:
10091
Nested Schema : kdsSettings
Type:
Show Source
object-
addHighlightScheme:
integer
Minimum Value:
0Maximum Value:999999999Example:0 -
addSortRule:
integer
Minimum Value:
0Maximum Value:2Example:1 -
backupRunnerChitPrint:
integer
Minimum Value:
0Maximum Value:999999999Example:0 -
beepOnNewOrder:
integer
Minimum Value:
0Maximum Value:3Example:1 -
beepOnPrioritizeIncremental:
integer
Minimum Value:
0Maximum Value:3Example:1 -
beepOnRush:
integer
Minimum Value:
0Maximum Value:3Example:1 -
beepOnVIP:
integer
Minimum Value:
0Maximum Value:3Example:1 -
course1FirstAlertTime:
integer
Minimum Value:
0Maximum Value:9999Example:10 -
course1SecondAlertTime:
integer
Minimum Value:
0Maximum Value:9999Example:20 -
displayNewOrderNotification:
boolean
Example:
true -
domType:
integer
Minimum Value:
0Maximum Value:3Example:1 -
modifyHighlightScheme:
integer
Minimum Value:
0Maximum Value:999999999Example:0 -
modifySortRule:
integer
Minimum Value:
0Maximum Value:2Example:1 -
newOrderNotificationTime:
integer
Minimum Value:
0Maximum Value:9999Example:15 -
otherCourseFirstAlertTime:
integer
Minimum Value:
0Maximum Value:9999Example:30 -
otherCourseSecondAlertTime:
integer
Minimum Value:
0Maximum Value:9999Example:40 -
primaryRunnerChitPrint:
integer
Minimum Value:
0Maximum Value:999999999Example:0 -
sendToPanel:
integer
Minimum Value:
1Maximum Value:9Example:1 -
voidHighlightScheme:
integer
Minimum Value:
0Maximum Value:999999999Example:0 -
voidSortRule:
integer
Minimum Value:
0Maximum Value:2Example:1 -
workflow:
integer
Minimum Value:
0Maximum Value:999Example:1
Nested Schema : items
Type:
Show Source
object-
associatedOrderDevice:
integer
Minimum Value:
1Maximum Value:32Example:4 -
lane:
integer
Minimum Value:
0Maximum Value:2Example:1
Nested Schema : items
Type:
Show Source
object-
linkedOrderDevice:
integer
Minimum Value:
1Maximum Value:32Example:3
Nested Schema : items
Type:
Show Source
object-
orderDevicesOptions:
string
Minimum Length:
32Maximum Length:3232-character order device option mask.Example:10000000000000000000000000000000 -
ordTypeIndex(required):
integer
Minimum Value:
1Maximum Value:32Example:1 -
rvcHierUnitId(required):
integer
Unique hierarchy unit value of the revenue center.Example:
10091
Nested Schema : items
Type:
Show Source
object-
objectNum(required):
integer
Minimum Value:
1Maximum Value:999999999Example:1 -
orderDevicesOptions:
string
Minimum Length:
32Maximum Length:3232-character order device option mask.Example:10000000000000000000000000000000