Get Printers
post
/config/sim/v2/devices/getPrinters
Gets all the Printers configured
Request
Supported Media Types
- application/json
- multipart/form-data
The input Body model that needs to be given.
Root Schema : schema
Type:
Show Source
object-
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 -
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 Printers.
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 Printer 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 Printer objects of the organization.
Show Source
-
Array of:
object Printersv2
Model for the Printers object
Nested Schema : Printersv2
Type:
objectModel for the Printers object
Show Source
-
hierUnitId:
integer
Unique hierarchy unit valueExample:
1 -
hierUnitObjNum:
integer
Hierarchy unit object numberExample:
1 -
name:
object name
A group of string objects representing the name of the Printer in configured languages.
-
objectNum:
integer
Object number of the PrinterExample:
1 -
options:
string
A string value of 0s & 1s of length 6 representing the enablement or disablement of the options associated with the PrinterExample:
000000 -
optionsExt:
object PrinterOptionsExt
An object containing the descriptive options list associated with the Print Class
-
printerConfiguration:
object PrinterConfiguration
An object containing the configuration settings for the printer
-
printerType:
integer
The type of the printer. The value must lie between 1 and 16 (both inclusive).Example:
1 -
trailingLineFeeds:
integer
The number of trailing line feeds, normally used in guest check and customer receipt.Example:
1 -
wsObjNum:
integer
Object number of the workstation to function as the print controller.Example:
1
Nested Schema : name
Type:
objectA group of string objects representing the name of the Printer in configured languages.
Example:
{
"1":"Enterprise",
"2":"Unternehmen",
"3":"Empresa"
}Nested Schema : PrinterOptionsExt
Type:
objectAn object containing the descriptive options list associated with the Print Class
Example:
{
"isMultiLingualCardInstalled":false,
"isThermalPrinter":false,
"isQuebecSRMDevice":false,
"printInLowRes":false,
"enableLoopPrinting":false,
"isDestinationPrinter":false
}Nested Schema : PrinterConfiguration
Type:
objectAn object containing the configuration settings for the printer
Show Source
-
address:
string
The IP address or hostname for the printer. If using the printer for banquet checks, enter the hostname. Applicable only if printerType = 2 / 3 / 4 / 11Example:
127.0.0.0 -
baudRate:
integer
The baud rate for the printer. Applicable only if printerType = 1/ 6 / 7 / 8 / 9 / 10 / 12 / 14Example:
1 -
bluetoothSettings:
object BluetoothSettings
Bluetooth settings
-
centerLogoUsing:
integer
The appropriate paper size for the printer to center the logo. 1 - 3 (1/8) (80mm) Paper 2 - 2 (1/4) (58mm) Paper. Applicable only if printerType = 3 / 11Example:
1 -
comPort:
string
The COM port for the printer. Applicable only if printerType = 1 / 6 / 7 / 8 / 9/ 10 / 12 / 14Example:
COM4 -
dataBits:
integer
The data bits for the printer. Applicable only if printerType = 1 / 6 / 7 / 8 / 9 / 10 / 12 / 14Example:
8 -
fileName:
string
The directory and file name to store the local disk file. Applicable only if printerType = 13Example:
/local/config.txt -
firstPageMargins:
object FirstPageMargins
An object containing the Bluetooth configuration settings for the printer. Applicable only if printerType = 4
-
idnId:
integer
The IDN ID for the printer. Applicable only if printerType = 12Example:
1 -
oposPrinterConfig:
object OposPrinterConfig
An object containing the configuration settings for the OPOS Printer. Applicable only if printerType = 15
-
otherPageMargins:
object FirstPageMargins
An object containing the Bluetooth configuration settings for the printer. Applicable only if printerType = 4
-
parity:
integer
The parity for the printer.0 - None 1 - Even 2 - Odd Applicable only if printerType = 1 / 6 / 7 / 8 / 9 / 10 / 12 / 14Example:
1 -
port:
integer
The port number for the IP printer. Applicable only if printerType = 2 / 3 / 4 / 11Example:
9100 -
serialNumber:
integer
The Serial Number of S1F2 terminal. Applicable only if printerType = 16Example:
123456789012345 -
stopBits:
integer
The stop bits for this printer. Applicable only if printerType = 1 / 6/ / 7 / 8 / 9 / 10 / 12 / 14Example:
1
Nested Schema : BluetoothSettings
Type:
objectBluetooth settings
Show Source
-
id:
string
The Bluetooth ID of the printer or leave the field blank to allow configuration from a Mobile client when using different printers per event.Example:
11:22:33:44:55:66 -
numberOfColumns:
integer
The column width of the printer.Example:
32 -
pin:
integer
The Bluetooth PIN of the printer.Example:
1
Nested Schema : FirstPageMargins
Type:
objectAn object containing the Bluetooth configuration settings for the printer. Applicable only if printerType = 4
Show Source
-
bottom:
integer
The bottom margin, in inches, for the page.Example:
0 -
left:
integer
The left margin, in inches, for the page.Example:
0 -
top:
integer
The top margin, in inches, for the page.Example:
0
Nested Schema : OposPrinterConfig
Type:
objectAn object containing the configuration settings for the OPOS Printer. Applicable only if printerType = 15
Show Source
-
bufferAllDateBeforePrint:
boolean
A Boolean flag indicating to enable fast OPOS printing. Does not work with all printers as it depends on OPOS printing implementation.Example:
false -
bufferOutput:
boolean
A Boolean flag indicating to enable faster printing for printers other than Epson printers.Example:
false -
deviceName:
string
The name of the deviceExample:
DeviceName -
printerColumns:
integer
The number of columns in the printerExample:
1 -
printerId:
integer
The identifier of the printerExample:
1 -
printPlainText:
boolean
A Boolean flag indicating to remove all OPOS commands and send plain text to the printer.Example:
false -
useNearEmptyAsEmpty:
boolean
A Boolean flag indicating to use near empty as emptyExample:
false