1. Configuration and Content API Guide
  2. Tasks
  3. Devices
  4. Workstations
  5. Workstations

Get Workstations

post

/config/sim/v1/devices/getWorkstations

Gets all the Workstation configured

Request

Supported Media Types
Body ()
A request body
Root Schema : WorkstationGetRequestBody
Type: object
The input Body model that needs to be given.
Show Source
  • Unique hierarchy unit value of the property
    Example: 1
  • Objects included in response
  • 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
  • If specified, limits translated strings returned.
  • Number of results returned in this page. Not required if paging parameters are not supported.
    Example: 10
  • Starting resource record index. Not required if paging parameters are not supported
    Example: 2
  • Sorts the response by the specified field name and sort order.
    Example: objectNum:asc
  • Search criteria to filter results based on field value.
    Example: where equals(active,1)
Back to Top

Response

Supported Media Types

200 Response

A collection of workstation device objects of the organization
Body ()
Root Schema : Workstation
Type: object
Show Source
Nested Schema : HierUnitNameTranslatedString
Type: object
A string that contains translations of hierarchy unit name into multiple languages
Example:
{
    "en-US":"Property",
    "de-DE":"Eigentum",
    "es-MX":"Propiedad"
}
Nested Schema : cashDrawerOptionsExt
Type: object
An object containing the descriptive cash drawer options list associated with the workstation
Show Source
  • A flag indicating to require workstation operators to assign themselves to a cash drawer using one of these function keys Assign Cash Drawer, Assign Cash Drawer 1, or Assign Cash Drawer 2.
    Example: false
  • A flag indicating to require an employee to have a cash drawer assigned prior to beginning a transaction. Deselect to allow any workstation operator to begin a transaction at the workstation.
    Example: false
  • A flag indicating to require that cash drawers attached to this workstation are closed before a new transaction can begin. Deselect to allow transactions to begin while a cash drawer is open.
    Example: false
  • A flag indicating to dedicate one cash drawer for foreign currency if two cash drawers are in use for the workstation. The foreign currency must allow change to be computed in that currency. This option is not available when Enterprise Cash Management is enabled.
    Example: false
Nested Schema : dataExtensions
Type: array
An array of data extensions for the menu item
Show Source
Nested Schema : devices
Type: array
An array of peripheral devices associated with the workstation
Show Source
Nested Schema : displayOptionsExt
Type: object
An object containing the descriptive options list associated with the workstation
Show Source
  • A flag indicating to hide the OPS window frame when the OPS UI is not in full-screen mode.
    Example: false
  • A flag indicating to allow the Payment Window workstation to automatically pick up the oldest open check (that has this workstation's order type) as soon as the current check is paid. When no more checks are open, the workstation prompts to check again or to exit the Auto-Pickup functionality. This option is intended for drive-thru environments that have an Ordering Window and a Payment Window.
    Example: false
  • A flag indicating to show the Change to Dispense in bills in the Change Due dialog so workstation operators can easily determine the change due in bills while the coin dispenser dispenses the rest of the amount.
    Example: false
  • A flag indicating to show discount totals and amount due on the second line of the customer display. Deselect to show only the amount due.
    Example: false
  • A flag indicating to show a non-rounded value for the total amount due on a customer display. You must also select Round Currency in the Currency Parameters module.
    Example: false
  • A flag indicating to cause the last screen of a transaction to remain on the display after the transaction is complete.
    Example: false
  • A flag indicating to suppress the currency symbol appearance on the rear/customer display.
    Example: false
  • A flag indicating to enable output to a rear customer display attached to the workstation.
    Example: false
  • A flag indicating if this is an Oracle Tablet that is not docked to a Base Station. When enabled, the tablet cannot configure or use the majority of the hardware devices that traditional workstations support.
    Example: false
  • A flag indicating to indicate that the workstation should prompt for a Destination Printer (if defined) when docked.
    Example: false
  • A flag indicating to show the mouse cursor for this workstation when workstations are installed on PCs (such as a hostess desk). This option is usually disabled for WS4 and other Oracle MICROS hardware platforms.
    Example: false
  • A flag indicating to use an LCD customer display. Deselect to use a pole display. This option is dimmed if Enable Rear Display is deselected.
    Example: false
Nested Schema : hardwareOptionsExt
Type: object
An object containing the descriptive hardware options list associated with the workstation
Show Source
  • A flag indicating to use an encrypted magnetic stripe reader. Once enabled, this option cannot be turned off. Before enabling this option, ensure that the credit card processor/gateway supports encryption.
    Example: false
  • A flag indicating to produce a beep tone each time an employee presses a key on the workstation.
    Example: false
  • A flag indicating to only allow credit card swipes to occur on a DynaPro reader and to turn off the internal reader. When enabled, if there is either no reader configured in the workstation's device table or the reader is not attached to the workstation, it is not possible to process credit cards through this workstation.
    Example: false
  • A flag indicating bit value for the Mobile Device Management(MDM) for POS Client Distribution . When disabled, Oracle is responsible for the support. When enabled, a third party company manages the required support activities on this device. This field is available only for these workstation types "1 - Mobile","2 - Workstation Client" and "6 - Tablet Client"
    Example: false
Nested Schema : miscOptionsExt
Type: object
An object containing the descriptive miscellaneous options list associated with the workstation
Show Source
  • A flag indicating to override RVC Parameters option 58- Auto Combo Items on the Fly option for the workstation. This option does nothing if the RVC Parameters option is deselected.
    Example: false
  • A flag indicating to enable Cashback. This configuration is in conjunction with the Enable Cashback option within Employee Classes.
    Example: false
  • A flag indicating if a workstation is configured, but is not actually a physical device. Do not select this option if a workstation is just turned off. There are instances where certain configuration parameters are not allowed unless all workstations in the Enterprise have been upgraded to the latest version.
    Example: false
  • A flag indicating to indicate that the workstation is a concessions terminal.
    Example: false
  • A flag indicating to start the KDS Display application when OPS starts.
    Example: false
  • A flag indicating to allow the workstation to link to a single cashier record. Deselect to post totals to the workstation operator's cashier record, if existing.
    Example: false
Nested Schema : offlineOptionsExt
Type: object
An object containing the descriptive offline options list associated with the workstation
Show Source
  • A flag indicating to allow this workstation to operate in Offline Mode
    Example: false
  • A flag indicating to prompt workstation operators to return online. Deselect to allow this workstation to automatically return to Online Mode when communications are reestablished.
    Example: false
  • A flag indicating to allow the workstation to go offline automatically when communication with the server is lost. Deselect to prompt the workstation operator to work offline.
    Example: false
Nested Schema : printJobConfiguration
Type: array
A group of objects representing the printer configuration for the workstation
Show Source
Nested Schema : revenueCenters
Type: array
An array of revenue centers that are available from this workstation when signing on.
Show Source
Nested Schema : routingGroups
Type: array
An array of objects representing the routing groups associated with the workstation
Show Source
Nested Schema : securityOptionsExt
Type: object
An object containing the descriptive security options list associated with the workstation
Show Source
  • A flag indicating to disable the Automatic Operator Popup Interval programmed in Control Parameters. Deselect to sign out workstation operators from this workstation after the Automatic Operator Popup Interval expires.
    Example: false
  • A flag indicating to require a scanned fingerprint and keyboard or touchscreen entry of an employee ID number. This applies to signing in, authorizing privileged operations, and so on.
    Example: false
  • A flag indicating to allow the workstation to accept employee ID entries made through the keyboard, touchscreen, or fingerprint scans. This applies to signing in, authorizing privileged operations, and so on
    Example: false
  • A flag indicating to require a scanned fingerprint for all employee ID entries at the workstation. This applies to signing in, authorizing privileged operations, and so on. Deselect to allow the workstation to accept employee ID numbers entered through keyboards or touchscreens.
    Example: false
  • A flag indicating to require a scanned fingerprint and a magnetic card swipe for all employee ID entries at the workstation. This applies to signing in, authorizing privileged operations, and so on.
    Example: false
  • A flag indicating to require that all employee ID entries at the workstation be made using a magnetic employee ID card. Deselect to allow employee ID entry by magnetic card, keyboard, or touchscreen.
    Example: false
  • A flag indicating to require a scanned fingerprint or a magnetic card swipe for all employee ID entries at the workstation. This applies to signing in, authorizing privileged operations, and so on.
    Example: false
  • A flag indicating to allow workstation operators to sign on to the workstation using the four-digit Alternate ID set in the employee record.
    Example: false
Nested Schema : svcHosts
Type: array
An array of services that are running on the workstation???s service host
Show Source
Nested Schema : items
Type: object
Show Source
Nested Schema : items
Type: object
Show Source
Nested Schema : items
Type: object
Show Source
Nested Schema : items
Type: object
Show Source
Nested Schema : items
Type: object
Show Source
Nested Schema : items
Type: object
Show Source
  • The port number for each service on the selected service host.
    Example: 8080
  • The sequence number of the service running of
    Example: 57261
  • The object number and name of the service record. For example, if a workstation, KDS Controller, and credit card driver are all running on the same Service Host, this column shows their object numbers and names.
    Example: 1-1
  • The Service Record Type for each service
    Example: Workstation
  • Datastamp up to which the totals were cleared up on this workstation.
    Example: 1
  • The URL of the service (informational only). It is used when constructing the full path to connect to the service. For example, Simphony Services are connected using a path such as http://ServiceHostName:Port/URL.
    Example: egateway/egateway.asmx

400 Response

400 Bad Request
Body ()
Root Schema : ErrorDetails
Type: object
Response body when the request returns an error.
Show Source
Back to Top