Update Workstation Devices
post
/config/sim/v1/devices/workstations/updateDevices
Updates a Workstation Device 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 : WorkstationDeviceCUDRequestBody
Type:
Show Source
object-
baudRate:
integer
Baud Rate of the device. Allowed values - 1200, 2400, 4800, 9600. This is a required field for the following device types - 1, 2, 3, 5, 8, 10, 12, 13, 14, 15(progId - Micros.Devices.FingerPrintReader.Opos), 16 and 17. 19200,38400Example:
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:
password -
comPort:
integer
COM Port of the device. This is a required field for the following device types - 1, 2, 3, 5, 8, 10, 12, 13, 14, 15(progId - Micros.Devices.FingerPrintReader.Opos), 16 and 17.Example:
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 device. This is a required field for the following device types - 1, 2, 3, 5, 8, 10, 12, 13, 14, 15(progId - Micros.Devices.FingerPrintReader.Opos), 16 and 17.Example:
1 -
deleteCertificate:
boolean
A flag indicating if the certificates need to be deleted. Applicable for type=20 and for SPI only.Example:
false -
deviceNum(required):
integer
Sequence number of the deviceExample:
1 -
deviceType(required):
integer
Type of the peripheral deviceExample:
1 -
hierUnitId(required):
integer
Unique hierarchy unit value of the propertyExample:
1 -
hostTimeoutInSecs:
integer
Timeout in seconds if request is abandonedExample:
180 -
objectNum(required):
integer
Object number of the workstationExample:
1 -
parity:
string
Parity of the device. This is a required field for the following device types - 1, 2, 3, 5, 8, 10, 12, 13, 14, 15(progId - Micros.Devices.FingerPrintReader.Opos), 16 and 17.Example:
N -
primaryHost:
string
URL of the endpoint. Format http(s)://host:port numberExample:
http://url.domain.com:443 -
progId(required):
string
Prog Id of the custom peripheral deviceExample:
Micros.Devices.BarCodeReader.RS232 -
securitySettings:
integer
Security settings for the interfaceExample:
1 -
serverCertCommonName:
string
Common name of the Server CertificateExample:
cert -
serverCertEffectiveDt:
string
Effective date of the server certificateExample:
2020-10-11 -
serverCertExpDt:
string
Effective date of the server certificateExample:
2020-10-11 -
serverCertificate:
string
Server certificate objectExample:
cert -
stopBits:
integer
Stop Bits of the device. This is a required field for the following device types - 1, 2, 3, 5, 8, 10, 12, 13, 14, 15(progId - Micros.Devices.FingerPrintReader.Opos), 16 and 17.Example:
1 -
validateXMLAgainstSchema:
boolean
A Boolean flag indicating if xml message is validated against schema and log errors. Applicable only for type=20 and SPI.Example:
false
Response
Supported Media Types
- application/json
200 Response
A collection of WorkstationDevice objects of the organization
Root Schema : WorkstationDeviceResponse
Type:
Show Source
object-
deviceNum(required):
integer
The sequence number of the deviceExample:
1 -
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