Get Workstation Devices
post
/config/sim/v1/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 : WorkstationDeviceGetRequestBody
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
Objects included in response
-
includeAll:
string
This can take 2 values: basic or detailed. If 'basic' is specified, The response contains all the properties of the object except
Ext values. If 'detailed' is specified, The response contains all the properties of the object. Example:detailed -
languages:
string
If specified, limits translated strings returned.
-
limit:
integer
Number of results returned in this page. Not required if paging parameters are not supported.Example:
10 -
objectNum(required):
integer
Object number of the workstationExample:
1 -
offset:
integer
Starting resource record index. Not required if paging parameters are not supportedExample:
2 -
orderBy:
string
Sorts the response by the specified field name and sort order.Example:
objectNum:asc -
searchCriteria:
string
Search criteria to filter results based on field valueExample:
where equals(active,1)
Response
Supported Media Types
- application/json
200 Response
A collection of workstation device objects of the organization
Root Schema : WorkstationDevice
Type:
Show Source
object-
baudRate(required):
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(required):
string
Client certificate common name of the payment interfaceExample:
Certificate -
clientCertEffectiveDt(required):
string
Client Certificate effective date of the payment interfaceExample:
2020-10-11 -
clientCertExpDt(required):
string
Expiration date of the client certificate of the payment interfaceExample:
2020-10-11 -
clientCertificate(required):
string
Client Certificate object. Applicable only for type=20 and SPIExample:
Cert -
clientCertPassword(required):
string
Client Certificate passwordExample:
password -
comPort(required):
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(required):
string
Configuration parameters of the custom peripheral deviceExample:
config -
customDevice(required):
integer
Device type of the custom peripheral deviceExample:
1 -
customDeviceSettingsConfig(required):
string
Configuration parameters of the peripheral deviceExample:
Custom Settings -
dataBits(required):
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(required):
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 -
hierUnitName(required):
object HierUnitNameTranslatedString
A string that contains translations of hierarchy unit name into multiple languages
-
hierUnitObjNum(required):
integer
Object number of the propertyExample:
1 -
hostTimeoutInSecs(required):
integer
Timeout in seconds if request is abandonedExample:
180 -
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 -
parity(required):
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(required):
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(required):
integer
Security settings for the interfaceExample:
1 -
serverCertCommonName(required):
string
Common name of the Server CertificateExample:
cert -
serverCertEffectiveDt(required):
string
Effective date of the server certificateExample:
2020-10-11 -
serverCertExpDt(required):
string
Effective date of the server certificateExample:
2020-10-11 -
serverCertificate(required):
string
Server certificate objectExample:
cert -
stopBits(required):
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(required):
boolean
A Boolean flag indicating if xml message is validated against schema and log errors. Applicable only for type=20 and SPI.Example:
false
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"
}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
404 Response
404 Requested resource not found