Add Printers
post
/config/sim/v1/devices/printers
Adds a printer record for the current organization.
Request
Supported Media Types
- application/json
- multipart/form-data
Header Parameters
-
Simphony-AuditTrailRef: string(string)
Detail that Identifies that who made the change
A request body
Root Schema : PrinterCUDRequestBody
Type:
objectModel for the Printer CUD Request
Show Source
-
hierUnitId(required):
integer
Unique hierarchy unit valueExample:
1 -
name(required):
object PrintClassNameTranslatedString
A string that contains translations of print class name into multiple languages
-
objectNum(required):
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 -
printerConfiguration:
object PrinterConfiguration
-
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 : PrintClassNameTranslatedString
Type:
objectA string that contains translations of print class name into multiple languages
Example:
{
"en-US":"Hotline PC",
"de-DE":"Hotline-PC"
}Nested Schema : PrinterConfiguration
Type:
Show Source
object-
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
text
-
centerLogoUsing:
integer
The appropriate paper size for the printer to center the logo.1 ??? 3 1/8??? (80mm) Paper 2 ??? 2 ????? (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
text
-
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
text
-
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:
1.23456789012345E14 -
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:
objecttext
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:
objecttext
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
Response
Supported Media Types
- application/json
200 Response
A collection of Printer objects of the organization
Root Schema : PrinterResponse
Type:
Show Source
object-
hierUnitId(required):
integer
Unique hierarchy unit valueExample:
1 -
objectNum(required):
integer
Object number of the printerExample:
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