Get Workstation Devices
post
/config/sim/v2/devices/workstations/getDevices
Gets all the Workstation Device configured for the specified organization
Request
Supported Media Types
- application/json
- multipart/form-data
A request body
Root Schema : schema
Type:
objectThe input Body model that needs to be given.
Show Source
-
hierUnitId(required):
integer
Unique hierarchy unit value of the propertyExample:
1 -
include:
string
If specified, limits the data returned to these fields.Example:
hierUnitId, objectNum, name -
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:
1,2,3 -
limit:
integer
If using paging, number of results returned in this page.Example:
100 -
objectNum(required):
integer
Object number of the workstationExample:
1 -
offset:
integer
Starting resource record index. Not required if paging parameters are not supportedExample:
0 -
orderBy:
string
Sorts the response by the specified field name and sort order.Example:
hierUnitId:asc -
searchCriteria:
string
If specified, returns records that match the criteria.Example:
where equals(hierUnitId, 7)
Response
Supported Media Types
- application/json
200 Response
A collection of Workstation Devices.
Root Schema : schema
Type:
Show Source
object-
count:
integer
Current response record count.Example:
9 -
hasMore:
boolean
Flag indicating if there are more objects to fetch.Example:
true -
items:
array items
Array of Workstation Device objects of the organization.
-
limit:
integer
Server page sizeExample:
10 -
offset:
integer
Starting resource record indexExample:
0 -
totalResults:
integer
Total number of rows (excluding the paging parameters)Example:
100
Nested Schema : items
Type:
arrayArray of Workstation Device objects of the organization.
Show Source
Nested Schema : WorkstationDevicev2
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:
integer
Sequence number of the deviceExample:
1 -
deviceType:
integer
Type of the peripheral deviceExample:
1 -
hierUnitId:
integer
Unique hierarchy unit value of the propertyExample:
1 -
hierUnitObjNum:
integer
Object number of the propertyExample:
1 -
hostTimeoutInSecs:
integer
Timeout in seconds if request is abandonedExample:
180 -
objectNum:
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:
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
Expiration 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