Jump to

• Request
• Response

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(optional): string(string)
  Detail that Identifies that who made the change
• Simphony-OrgShortName: string(string)
  Org Identifier

Body ()

Printer Object

Root Schema : Printers

Type: object

Model for the Printers object

Show Source

• hierUnitId: integer
  Unique hierarchy unit value

  Example: 1
• hierUnitName(optional): object HierUnitNameTranslatedString
  A string that contains translations of hierarchy unit name into multiple languages
• hierUnitObjNum(optional): integer
  Hierarchy unit object number

  Example: 1
• name: object PrintClassNameTranslatedString
  A string that contains translations of print class name into multiple languages
• objectNum: integer
  Object number of the Printer

  Example: 1
• options(optional): integer
  A string value of 0???s & 1???s representing the enablement or disablement of the options associated with the Printer

  Example: 1
• optionsExt(optional): object PrinterOptionsExt
  An object containing the descriptive options list associated with the Print Class
• printerConfiguration(optional): object PrinterConfiguration
• printerType(optional): integer
  The type of the printer.

  Example: 1
• trailingLineFeeds(optional): integer
  The number of trailing line feeds, normally used in guest check and customer receipt.

  Example: 1
• wsName(optional): integer
  Name of the workstation to function as the print controller.in configured languages

  Example: 1
• wsObjNum(optional): integer
  Object number of the workstation to function as the print controller.

  Example: 1

{
    "description":"Model for the Printers object",
    "type":"object",
    "required":[
        "hierUnitId",
        "objectNum",
        "name"
    ],
    "properties":{
        "hierUnitId":{
            "description":"Unique hierarchy unit value",
            "type":"integer",
            "example":1
        },
        "hierUnitObjNum":{
            "description":"Hierarchy unit object number",
            "type":"integer",
            "example":1
        },
        "hierUnitName":{
            "$ref":"#/definitions/HierUnitNameTranslatedString"
        },
        "objectNum":{
            "description":"Object number of the Printer",
            "type":"integer",
            "example":1
        },
        "name":{
            "$ref":"#/definitions/PrintClassNameTranslatedString"
        },
        "wsObjNum":{
            "description":"Object number of the workstation to function as the print controller.",
            "type":"integer",
            "example":1
        },
        "wsName":{
            "description":"Name of the workstation to function as the print controller.in configured languages",
            "type":"integer",
            "example":1
        },
        "printerType":{
            "description":"The type of the printer.",
            "type":"integer",
            "example":1
        },
        "trailingLineFeeds":{
            "description":"The number of trailing line feeds, normally used in guest check and customer receipt.",
            "type":"integer",
            "example":1
        },
        "options":{
            "description":"A string value of 0???s & 1???s representing the enablement or disablement of the options associated with the Printer",
            "type":"integer",
            "example":1
        },
        "optionsExt":{
            "$ref":"#/definitions/PrinterOptionsExt"
        },
        "printerConfiguration":{
            "description":"An object containing the configuration settings for the printer",
            "$ref":"#/definitions/PrinterConfiguration"
        }
    }
}

Nested Schema : HierUnitNameTranslatedString

Type: object

A string that contains translations of hierarchy unit name into multiple languages

Example:

{
    "en-US":"Property",
    "de-DE":"Eigentum",
    "ar-AR":"??????????"
}

Nested Schema : PrintClassNameTranslatedString

Type: object

A string that contains translations of print class name into multiple languages

Example:

{
    "en-US":"Hotline PC",
    "de-DE":"Hotline-PC"
}

Nested Schema : PrinterOptionsExt

Type: object

An 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: object

Show Source

• address(optional): 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 / 11

  Example: 127.0.0.0
• baudRate(optional): integer
  The baud rate for the printer. Applicable only if printerType = 1/ 6 / 7 / 8 / 9 / 10 / 12 / 14

  Example: 1
• bluetoothSettings(optional): object BluetoothSettings
  text
• centerLogoUsing(optional): 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 / 11

  Example: 1
• comPort(optional): integer
  The COM port for the printer. Applicable only if printerType = 1 / 6 / 7 / 8 / 9/ 10 / 12 / 14

  Example: 1
• dataBits(optional): integer
  The data bits for the printer. Applicable only if printerType = 1 / 6 / 7 / 8 / 9 / 10 / 12 / 14

  Example: 8
• fileName(optional): string
  The directory and file name to store the local disk file. Applicable only if printerType = 13

  Example: ???/local/config.txt???
• firstPageMargins(optional): object FirstPageMargins
  text
• idnId(optional): integer
  The IDN ID for the printer. Applicable only if printerType = 12

  Example: 1
• oposPrinterConfig(optional): object OposPrinterConfig
  An object containing the configuration settings for the OPOS Printer. Applicable only if printerType = 15
• otherPageMargins(optional): object FirstPageMargins
  text
• parity(optional): integer
  The parity for the printer.0 ??? None 1 ??? Even 2 ??? Odd Applicable only if printerType = 1 / 6 / 7 / 8 / 9 / 10 / 12 / 14

  Example: 1
• port(optional): integer
  The port number for the IP printer. Applicable only if printerType = 2 / 3 / 4 / 11

  Example: 9100
• serialNumber(optional): integer
  The Serial Number of S1F2 terminal. Applicable only if printerType = 16

  Example: 1.23456789012345E14
• stopBits(optional): integer
  The stop bits for this printer. Applicable only if printerType = 1 / 6/ / 7 / 8 / 9 / 10 / 12 / 14

  Example: 1

{
    "type":"object",
    "properties":{
        "comPort":{
            "description":"The COM port for the printer. Applicable only if printerType = 1 / 6 / 7 / 8 / 9/ 10 / 12 / 14",
            "type":"integer",
            "example":1
        },
        "baudRate":{
            "description":"The baud rate for the printer. Applicable only if printerType = 1/ 6 / 7 / 8 / 9 / 10 / 12 / 14",
            "type":"integer",
            "example":1
        },
        "parity":{
            "description":"The parity for the printer.0 ??? None 1 ??? Even 2 ??? Odd Applicable only if printerType = 1 / 6 / 7 / 8 / 9 / 10 / 12 / 14",
            "type":"integer",
            "example":1
        },
        "dataBits":{
            "description":"The data bits for the printer. Applicable only if printerType = 1 / 6 / 7 / 8 / 9 / 10 / 12 / 14",
            "type":"integer",
            "example":8
        },
        "stopBits":{
            "description":"The stop bits for this printer. Applicable only if printerType = 1 / 6/ / 7 / 8 / 9 / 10 / 12 / 14",
            "type":"integer",
            "example":1
        },
        "address":{
            "description":"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 / 11",
            "type":"string",
            "example":"127.0.0.0"
        },
        "port":{
            "description":"The port number for the IP printer. Applicable only if printerType = 2 / 3 / 4 / 11",
            "type":"integer",
            "example":9100
        },
        "centerLogoUsing":{
            "description":"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 / 11",
            "type":"integer",
            "example":1
        },
        "firstPageMargins":{
            "description":"An object containing the Bluetooth configuration settings for the printer. Applicable only if printerType = 4",
            "$ref":"#/definitions/FirstPageMargins"
        },
        "otherPageMargins":{
            "description":"An object containing the Bluetooth configuration settings for the printer. Applicable only if printerType = 4",
            "$ref":"#/definitions/FirstPageMargins"
        },
        "bluetoothSettings":{
            "$ref":"#/definitions/BluetoothSettings"
        },
        "idnId":{
            "description":"The IDN ID for the printer. Applicable only if printerType = 12",
            "type":"integer",
            "example":1
        },
        "fileName":{
            "description":"The directory and file name to store the local disk file. Applicable only if printerType = 13",
            "type":"string",
            "example":"???/local/config.txt???"
        },
        "oposPrinterConfig":{
            "$ref":"#/definitions/OposPrinterConfig"
        },
        "serialNumber":{
            "description":"The Serial Number of S1F2 terminal. Applicable only if printerType = 16",
            "type":"integer",
            "example":1.23456789012345E14
        }
    }
}

Nested Schema : BluetoothSettings

Type: object

text

Show Source

• id(optional): 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(optional): integer
  The column width of the printer.

  Example: 32
• pin(optional): integer
  The Bluetooth PIN of the printer.

  Example: 1

{
    "description":"text",
    "type":"object",
    "properties":{
        "pin":{
            "description":"The Bluetooth PIN of the printer.",
            "type":"integer",
            "example":1
        },
        "id":{
            "description":"The Bluetooth ID of the printer or leave the field blank to allow configuration from a Mobile client when using different printers per event.",
            "type":"string",
            "example":"11:22:33:44:55:66"
        },
        "numberOfColumns":{
            "description":"The column width of the printer.",
            "type":"integer",
            "example":32
        }
    }
}

Nested Schema : FirstPageMargins

Type: object

text

Show Source

• bottom(optional): integer
  The bottom margin, in inches, for the page.

  Example: 0
• left(optional): integer
  The left margin, in inches, for the page.

  Example: 0
• top(optional): integer
  The top margin, in inches, for the page.

  Example: 0

{
    "description":"text",
    "type":"object",
    "properties":{
        "top":{
            "description":"The top margin, in inches, for the page.",
            "type":"integer",
            "example":0
        },
        "bottom":{
            "description":"The bottom margin, in inches, for the page.",
            "type":"integer",
            "example":0
        },
        "left":{
            "description":"The left margin, in inches, for the page.",
            "type":"integer",
            "example":0
        }
    }
}

Nested Schema : OposPrinterConfig

Type: object

An object containing the configuration settings for the OPOS Printer. Applicable only if printerType = 15

Show Source

• bufferAllDateBeforePrint(optional): 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(optional): boolean
  A Boolean flag indicating to enable faster printing for printers other than Epson printers.

  Example: false
• deviceName(optional): string
  The name of the device

  Example: DeviceName
• printerColumns(optional): integer
  The number of columns in the printer

  Example: 1
• printerId(optional): integer
  The identifier of the printer

  Example: 1
• printPlainText(optional): boolean
  A Boolean flag indicating to remove all OPOS commands and send plain text to the printer.

  Example: false
• useNearEmptyAsEmpty(optional): boolean
  A Boolean flag indicating to use near empty as empty

  Example: false

{
    "description":"An object containing the configuration settings for the OPOS Printer. Applicable only if printerType = 15",
    "type":"object",
    "properties":{
        "deviceName":{
            "description":"The name of the device",
            "type":"string",
            "example":"DeviceName"
        },
        "printerColumns":{
            "description":"The number of columns in the printer",
            "type":"integer",
            "example":1
        },
        "printerId":{
            "description":"The identifier of the printer",
            "type":"integer",
            "example":1
        },
        "useNearEmptyAsEmpty":{
            "description":"A Boolean flag indicating to use near empty as empty",
            "type":"boolean",
            "example":false
        },
        "bufferOutput":{
            "description":"A Boolean flag indicating to enable faster printing for printers other than Epson printers.",
            "type":"boolean",
            "example":false
        },
        "bufferAllDateBeforePrint":{
            "description":"A Boolean flag indicating to enable fast OPOS printing. Does not work with all printers as it depends on OPOS printing implementation.",
            "type":"boolean",
            "example":false
        },
        "printPlainText":{
            "description":"A Boolean flag indicating to remove all OPOS commands and send plain text to the printer.",
            "type":"boolean",
            "example":false
        }
    }
}

Back to Top

Response

Supported Media Types

• application/json

200 Response

A collection of Printer objects of the organization

Body ()

Root Schema : PrinterResponse

Type: object

Show Source

• hierUnitId: integer
  Unique hierarchy unit value

  Example: 1
• objectNum: integer
  Object number of the printer

  Example: 1

{
    "type":"object",
    "required":[
        "hierUnitId",
        "objectNum"
    ],
    "properties":{
        "hierUnitId":{
            "type":"integer",
            "description":"Unique hierarchy unit value",
            "example":1
        },
        "objectNum":{
            "description":"Object number of the printer",
            "type":"integer",
            "example":1
        }
    }
}

400 Response

400 Bad Request

Body ()

Root Schema : ErrorDetails

Type: object

Response body when the request returns an error.

Show Source

• detail(optional): string
  A short, human-readable summary of the problem.

  Example: Specified Data is invalid
• errorDetails(optional): string
  A human-readable explanation specific to this occurrence of the problem.

  Example: Entity Does Not Exist
• o:errorCode(optional): integer
  Error code of the problem

  Example: 55223
• status(optional): integer
  HTTP status code.

  Example: 400
• title(optional): string
  A short, human-readable summary of the problem type.

  Example: VALIDATION ERROR
• type(optional): 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

{
    "description":"Response body when the request returns an error.\n",
    "type":"object",
    "properties":{
        "o:errorCode":{
            "description":"Error code of the problem",
            "type":"integer",
            "example":55223
        },
        "detail":{
            "description":"A short, human-readable summary of the problem.",
            "type":"string",
            "example":"Specified Data is invalid"
        },
        "status":{
            "description":"HTTP status code.",
            "type":"integer",
            "example":400
        },
        "type":{
            "description":"A URI reference that identifies the problem type. When this member is not present, its value is assumed to be \"about:blank\".",
            "type":"string",
            "example":"http://www.abc.org/xyz.html"
        },
        "title":{
            "description":"A short, human-readable summary of the problem type.",
            "type":"string",
            "example":"VALIDATION ERROR"
        },
        "errorDetails":{
            "description":"A human-readable explanation specific to this occurrence of the problem.",
            "type":"string",
            "example":"Entity Does Not Exist"
        }
    }
}

Back to Top