Update Workstations
post
/config/sim/v1/devices/updateWorkstations
Updates a Workstation record for the current organization.
Request
Supported Media Types
- application/json
- multipart/form-data
Header Parameters
-
Simphony-AuditTrailRef: string(string)
Detail that identifies who made the change.
A request body
Root Schema : WorkstationCUDRequestBody
Type:
Show Source
object-
barcodeFormatSetObjNum:
integer
Object number of the barcode format to use for the workstation.Example:
0 -
cashDrawerOptions:
string
A string value of 0s & 1s of length 4 representing the enablement or disablement of the cash drawer options associated with the workstationExample:
0000 -
cashDrawers:
integer
The number of cash drawers that are physically installed at this workstation. Maximum of 2 cash drawers can be installed at the workstationExample:
0 -
cashierLinkObjNum:
integer
Object number of the cashier record to link to the workstation. You must also select 8 - On = Link Cashier Totals to Workstation; Off = Link to Operator in the Workstations module.Example:
0 -
cdBeepTimeoutInSecs:
integer
The number of seconds the cash drawer can stay open before the workstation begins beeping. If set to 0, no beeping occurs. You must also select option 3 - Require Cash Drawer to be Closed Before New Transaction in the Workstations module.Example:
0 -
cdNotifyTimeoutInSecs:
integer
The number of seconds the cash drawer can stay opened before the workstation posts a message to the journal log. If set to 0, no message posts to the journal log. This function only works when Workstations option 3 - Require Cash Drawer to be Closed Before New Transaction is enabled.Example:
0 -
checkInactivtyTimeoutInSecs:
integer
the number of seconds the workstation waits before showing a message (Do you need more time?), prompting the workstation operator to cancel the transaction. If set to 0, the prompt does not appear. If RVC Parameter Follow Me is enabled, the check is automatically suspended rather than canceled.Example:
0 -
chkInactiveDialogTimeoutInSecs:
integer
The number of seconds the workstation shows the Inactivity Dialog before automatically canceling the transaction. If set to 0, the transaction does not automatically cancel.Example:
0 -
dataExtensions:
array dataExtensions
An array of data extensions for the menu item
-
dbUpdateFrequencyInSecs:
integer
The number of seconds the workstation waits to retrieve updates from the database. This field overrides the Property Parameters Database Update Frequency setting.Example:
0 -
defaultGateway:
string
The Default Gateway of the service host where the workstation application runs.Example:
0.0.0.0 -
defaultOrderChannelObjNum:
integer
Object number of the order channel to remain active on the workstation, unless changed manually.Example:
1 -
defltOrderTypeObjNum:
integer
Object number of the order type to remain active on the workstation, unless changed manually.Example:
1 -
devices:
array devices
An array of peripheral devices associated with the workstation
-
displayOptions:
string
A string value of 0s & 1s of length 13 representing the enablement or disablement of the display options associated with the workstationExample:
0000000000000 -
enabledOrderDevices:
string
A string of 0s and 1s of length 32 representing the enablement of the order devices outputs from the workstationExample:
00000000000000000000000000000000 -
enableSTSGen1:
boolean
A Boolean flag indicating to enable Simphony Transaction Services Gen 1 for the workstationExample:
false -
enableSTSGen2Cloud:
boolean
A Boolean flag indicating to enable Simphony Transaction Services Gen 2 for Cloud for the workstationExample:
false -
enableSTSGen2Loc:
boolean
A Boolean flag indicating to enable Simphony Transaction Services Gen 2 for location for the workstationExample:
false -
hardwareOptions:
string
A string value of 0s & 1s of length 4 representing the enablement or disablement of the 4 hardware options associated with the workstationExample:
0000 -
hierUnitId(required):
integer
Unique hierarchy unit value of the propertyExample:
1 -
hostName:
string
The IP address or host name of the service host where the workstation application runs.Example:
0.0.0.0 -
isWindowsService:
boolean
A Boolean flag indicating to run the service host as a Windows service (without GUI).Example:
false -
languageObjNum:
integer
Object number of the default language for the workstation sign-on screen.Example:
1 -
locFromLeft:
integer
Specify how far from the left (in pixels) the workstation window should be placed on the display screen.Example:
0 -
locFromTop:
integer
Specify how far from the top (in pixels) the workstation window should be placed on the display screen.Example:
0 -
logVerbosity:
integer
The logging verbosity for the Workstation. Select 0 (zero) for minimal logging. Higher settings cause the workstation's disk or flash drive to fill more quickly.Example:
0 -
maxGuestCheckNum:
integer
the maximum check number to use when The workstation is in offline mode. The workstation is used in revenue centers without the RVC Parameters option Use Revenue Center Check Numbers. In these revenue centers, each workstation determines its own check number range.Example:
99999999 -
minGuestCheckNum:
integer
the minimum check number to use when The workstation is in offline mode. The workstation is used in revenue centers without the RVC Parameters option Use Revenue Center Check Numbers. In these revenue centers, each workstation determines its own check number range.Example:
1 -
miscOptions:
string
A string value of 0s & 1s of length 6 representing the enablement or disablement of the miscellaneous options associated with the workstationExample:
000000 -
name(required):
object HierUnitNameTranslatedString
A string that contains translations of hierarchy unit name into multiple languages
-
objectNum(required):
integer
Object number of the workstationExample:
1 -
offlineOptions:
string
A string value of 0s & 1s of length 3 representing the enablement or disablement of the offline options associated with the workstationExample:
000 -
printJobConfiguration:
array printJobConfiguration
A group of objects representing the printer configuration for the workstation
-
reportTimeoutInSecs:
integer
The number of seconds the workstation waits to retrieve reporting information before failing. The gateway report service uses a separate timeout while waiting for a response from the Reporting and Analytics server.Example:
0 -
reslCols:
integer
the number of resolution columns for the workstation's display. This must correspond to one of the resolutions defined in the workstation's INI file or leave it at 0 (zero) as a default.Example:
0 -
reslRows:
integer
the number of resolution rows for the workstation's display. This must correspond to one of the resolutions defined in the workstation's INI file or leave it at 0 (zero) as a default.Example:
0 -
revenueCenters:
array revenueCenters
An array of revenue centers that are available from this workstation when signing on.
-
routingGroups:
array routingGroups
An array of objects representing the routing groups associated with the workstation
-
securityOptions:
string
A string value of 0s & 1s of length 8 representing the enablement or disablement of the security options associated with the workstationExample:
00000000 -
subnetMask:
string
The Subnet Mask of the service host where the workstation application runs.Example:
0.0.0.0 -
svcHostID:
integer
The service host where the workstation application runs. It is auto-generated, except for workstation type 3. For type 3, the service host of existing workstation can be assigned.Example:
17121 -
svcHosts:
array svcHosts
An array of services that are running on the workstation???s service host
-
thaiTaxRDNum:
string
The number to print on Thai Tax trailers. The name RD NUM must be included as part of the descriptor line to be printed in the trailer.Example:
TU1 -
type(required):
integer
The type of the workstation.Example:
2 -
wlsStrengthOfflineThreshold:
integer
The percentage amount to be used to determine if communications should be suspended for wireless workstations, until network signal strength is improved.Example:
0 -
wlsStrengthReconnectThreshold:
integer
The percentage amount of signal strength to be used to determine at which point the system attempts to reconnect wireless workstations to the network. This setting must be a higher value than the Offline Threshold setting.Example:
0 -
wsClassObjNum:
integer
Object number of the Workstation Class for this workstation.Example:
0
Nested Schema : dataExtensions
Type:
arrayAn array of data extensions for the menu item
Show Source
Nested Schema : devices
Type:
arrayAn array of peripheral devices associated with the workstation
Show Source
Nested Schema : HierUnitNameTranslatedString
Type:
objectA string that contains translations of hierarchy unit name into multiple languages
Example:
{
"en-US":"Property",
"de-DE":"Eigentum",
"es-MX":"Propiedad"
}Nested Schema : printJobConfiguration
Type:
arrayA group of objects representing the printer configuration for the workstation
Show Source
Nested Schema : revenueCenters
Type:
arrayAn array of revenue centers that are available from this workstation when signing on.
Show Source
Nested Schema : routingGroups
Type:
arrayAn array of objects representing the routing groups associated with the workstation
Show Source
Nested Schema : svcHosts
Type:
arrayAn array of services that are running on the workstation???s service host
Show Source
Nested Schema : items
Type:
Show Source
object-
columnName:
string
Name of the extension fieldExample:
extension column 1 -
value:
string
Value of the extension fieldExample:
Value1
Nested Schema : items
Type:
Show Source
object-
baudRate:
integer
Baud Rate of the device.Example:
9600 -
clientCertCommonName:
string
Client certificate common name of the payment interfaceExample:
certificate -
clientCertEffectiveDt:
string
Client Certificate effective date of the payment interfaceExample:
2020-10-11 -
clientCertExpDt:
string
Expiration date of the client certificate of the payment interfaceExample:
2020-10-11 -
clientCertificate:
string
Client Certificate object. Applicable only for type=20 and SPIExample:
Cert -
clientCertPassword:
string
Client Certificate passwordExample:
passw0rd -
comPort:
integer
COM Port of the deviceExample:
1 -
configuration:
string
Configuration parameters of the custom peripheral deviceExample:
config -
customDevice:
integer
Device type of the custom peripheral deviceExample:
1 -
customDeviceSettingsConfig:
string
Configuration parameters of the peripheral deviceExample:
Custom Settings -
dataBits:
integer
Data bits of the deviceExample:
8 -
deleteCertificate:
boolean
A flag indicating if the certificates need to be deleted. Applicable for type=20 and for SPI onlyExample:
false -
deviceNum(required):
integer
Sequence number of the deviceExample:
1 -
deviceType:
integer
Type of the peripheral device. Valid device types are 1, 2, 3, 5, 8, 10, 12, 13, 14, 15, 16, 17, 18, 20.Example:
1 -
hostTimeoutInSecs:
integer
Timeout in seconds if request is abandonedExample:
180 -
parity:
string
Parity of the deviceExample:
N -
primaryHost:
string
URL of the endpoint. Format http(s)://host:port numberExample:
http://url.domain.com:443 -
progId:
string
Prog Id of the custom peripheral deviceExample:
1 -
securitySettings:
integer
Security settings for the interfaceExample:
1 -
serverCertCommonName:
string
Common name of the Server CertificateExample:
certificate -
serverCertEffectiveDt:
string
Effective date of the server certificateExample:
2020-10-11 -
serverCertExpDt:
string
Expiration date of the server certificateExample:
2020-10-11T00:00:00.000Z -
serverCertificate:
string
Server certificate objectExample:
Cert -
stopBits:
integer
Stop Bits of the deviceExample:
2 -
validateXMLAgainstSchema:
boolean
A Boolean flag indicating if the XML message is validated against schema and log errors. Applicable only for type=20 and SPIExample:
false
Nested Schema : items
Type:
Show Source
object-
destPrinterGroupObjNum:
integer
Object number of the Printer Group to be displayed to allow a printer to be chosen.Example:
1 -
printerObjNum:
integer
Object number of the printerExample:
1 -
printerType:
integer
The type of the printerExample:
1
Nested Schema : items
Type:
Show Source
object-
index:
integer
Index of the revenue center. There can be only a maximum of 8 revenue center available to a workstation. Index =1 indicates the default revenue center for the workstationExample:
1 -
rvcObjNum:
integer
Object number of the revenue centerExample:
1
Nested Schema : items
Type:
Show Source
object-
routingGroupObjNum:
integer
Object number of the routing groupExample:
1
Nested Schema : items
Type:
Show Source
object-
port:
string
The port number for each service on the selected service host.Example:
8080 -
svcHostType:
string
The Service Record Type for each serviceExample:
Workstation
Response
Supported Media Types
- application/json
200 Response
A collection of WorkstationDevice objects of the organization
Root Schema : WorkstationResponse
Type:
Show Source
object-
hierUnitId(required):
integer
Unique hierarchy unit value of the propertyExample:
1 -
objectNum(required):
integer
Object number of the workstationExample:
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