Update Order Devices
post
/config/sim/v1/devices/updateOrderDevices
Updates an order devices record for the current organization.
Request
Supported Media Types
- application/json
- multipart/form-data
Header Parameters
-
Simphony-AuditTrailRef: string(string)
Detail that Identifies that who made the change
A request body
Root Schema : OrderDeviceCUDRequestBody
Type:
Show Source
object-
backupDeviceObjNum:
integer
Object number of the backup order device in the event of a communication failure or other problem.Example:
0 -
condimentSortType(required):
integer
Specify how condiments will be sorted on the selected order device. The options are:1 - No condiment sorting ??? (Condiments are listed in the order entered by the user) 2 - Sort allowed condiments ??? (Required condiments are not sorted) 3 - Sort all condiments (All condiments are sorted)Example:
1 -
customInstructions:
string
instructions (up to 250 characters) for the workstation's script to handle order output based on custom instructions in the script in case of using Custom Print HandlingExample:
Custom Instructions -
deviceObjNum:
integer
Object number of the relevant order device record.Example:
0 -
deviceType(required):
integer
The remote device to which orders print. For a local device, orders print at the Local Order Receipt printer set for the workstation from which the order is placed. 1 ??? Remote 2 - LocalExample:
1 -
hierUnitId(required):
integer
Unique hierarchy unit valueExample:
1 -
kdsOptions:
string
A string value of 0s & 1s of length 48 representing the enablement or disablement of the options associated with the Printer Order Device. Applicable if primaryDeviceType = 0Example:
000000000000000000000000000000000000000000000000 -
kdsSettings:
object kdsSettings
-
language2ObjNum:
string
Object number of the secondary language for the print output. Applicable only if primaryDeviceType = 0Example:
English -
language3ObjNum:
string
Object number of the third language for the print output. Applicable only if primaryDeviceType = 0Example:
English -
languageObjNum:
integer
Object number of the primary language for the order device. Applicable only if primaryDeviceType = 0Example:
1 -
lineFeedBeforeOrder:
integer
The number of lines to advance before printing the order on order chits. Applicable only if primaryDeviceType = 0Example:
0 -
lineFeedsAfterOrder:
integer
The number of lines to advance after printing the order on order chits. Applicable only if primaryDeviceType = 0Example:
0 -
maxNumLinePerChit:
integer
the maximum number of lines (0-99) to print on each page of an order chit. Applicable only if primaryDeviceType = 0Example:
0 - menuItemPrinting(required): integer
-
name:
object OrderDeviceTranslatedString
name of the Order Device
-
objectNum(required):
integer
Object number of the Order DeviceExample:
1 -
orderDeviceRedirectObjNum:
integer
Object number of the order device to which orders sent to this device should be redirected. Typically, this field is set to itself.Example:
0 -
primaryDeviceType:
integer
The remote device to which orders print. For a local device, orders print at the Local Order Receipt printer set for the workstation from which the order is placed. 1 ??? Remote 2 - LocalExample:
0 -
primaryDistGroupObjNum:
integer
Object number of the Primary Distribution Group for the KDS. Applicable only if primaryDeviceType = 1Example:
1 -
printerOptions:
string
A string value of 0s & 1s of length 48 representing the enablement or disablement of the options associated with the Printer Order Device. Applicable if primaryDeviceType = 0Example:
000000000000000000000000000000000000000000000000 -
sortConsoldiationMethod:
integer
the sort and consolidation method for the order device 0 ??? Do Not Sort 1 ??? Seat Consolidated 2 ??? Seat No Consolidation 3 ??? Print Group Consolidated 4 ??? Print Group No Consolidation 5 ??? Seat & Print Group Consolidated 6 ??? Seat & Print Group No Consolidation 7 ??? Print Group and Seat Consolidated 8 ??? Print Group and Seat No Consolidation Applicable only if primaryDeviceType = 0Example:
0
Nested Schema : kdsSettings
Type:
Show Source
object-
addHighlightScheme:
integer
The color configuration to use to highlight items with the quantity changed.Example:
0 -
addSortRule:
integer
The sort type to use when the quantity of an item changes.Example:
0 -
backupRunnerChitPrinterObjNum:
integer
Object number of the printer where runner chits print when orders are bumped from the KDS if Simphony cannot establish communication with the primary runner chit printerExample:
0 -
beepOnNewOrder:
integer
The sound type to emit when an order is received on the order deviceExample:
0 -
beepOnPrioritize:
integer
The sound type to emit when an order is prioritized or the order priority is increased on the order device. 0 ??? None 1 ??? PC Speaker 2 ??? WAV File 3 ??? Bump Bar SpeakerExample:
0 -
beepOnRush:
integer
0 ??? None 1 ??? PC Speaker 2 ??? WAV File 3 ??? Bump Bar SpeakerExample:
0 -
beepOnVIP:
integer
The sound type to emit when a VIP order is received.Example:
0 -
course1FirstAlertTimeInSecs:
integer
The amount of time, in seconds, for course 1 items to show the first alert.Example:
0 -
course1SecondAlertTimeInSecs:
integer
The amount of time, in seconds, for course 2 items to show the second alert.Example:
0 -
displayNewOrderNotification:
boolean
A Boolean flag indicating to make new orders flash when appearing on the KDS Display if not using DOMExample:
false -
domType:
integer
the Dynamic Order Mode type for the KDS Display.Example:
0 -
modifyHighlightScheme:
integer
The color configuration to use to highlight modified items on orders.Example:
0 -
modifySortRule:
integer
The sort type to use when existing items on an order are modified.\ 0 ??? Sort to TopExample:
0 -
newOrderNotificationTimeInSecs:
integer
The length of time, in seconds, newly added items flash on screen.Example:
0 -
othCourseFirstAlertTimeInSecs:
integer
The amount of time, in seconds, for any course except course 1 to show the first alert.Example:
0 -
othCourseSecondAlertTimeInSecs:
integer
The amount of time, in seconds, for any course except course 1 to show the second alert.Example:
0 -
primaryRunnerChitPrinterObjNum:
integer
Object number of the printer where runner chits print when orders are bumped from the KDS.Example:
0 -
sendToPanelNum:
integer
The number of a panel (1 through 9) where orders appear on this device.Example:
0 -
voidHighlightScheme:
integer
The color configuration to use to highlight voided items.Example:
0 -
voidSortRule:
integer
The sort type to use when an item is voided.Example:
0
Nested Schema : OrderDeviceTranslatedString
Type:
objectname of the Order Device
Example:
{
"en-US":"Order Device 1",
"es-MX":"Dispositivo de pedido"
}Response
Supported Media Types
- application/json
200 Response
A collection of Order Devices objects of the organization
Root Schema : OrderDevice
Type:
Show Source
object-
hierUnitId(required):
integer
Unique hierarchy unit valueExample:
1 -
objectNum(required):
integer
Object number of the printerExample:
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