Show Source

• hierUnitId(required): integer
  Unique hierarchy unit value

  Example: 1
• name(required): object name
  Name
• objectNum(required): integer
  Object number of the Printer

  Example: 1
• options: string
  A string value of 0s & 1s of length 6 representing the enablement or disablement of the options associated with the Printer

  Example: 000000
• 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

{
    "description":"Model for the Printer CUD Request",
    "type":"object",
    "required":[
        "hierUnitId",
        "objectNum",
        "name"
    ],
    "properties":{
        "hierUnitId":{
            "description":"Unique hierarchy unit value",
            "type":"integer",
            "example":1
        },
        "objectNum":{
            "description":"Object number of the Printer",
            "type":"integer",
            "example":1
        },
        "name":{
            "type":"object",
            "description":"Name",
            "example":{
                "en-US":"Hotline PC",
                "de-DE":"Hotline-PC"
            }
        },
        "wsObjNum":{
            "description":"Object number of the workstation to function as the print controller.",
            "type":"integer",
            "example":1
        },
        "printerType":{
            "description":"The type of the printer. The value must lie between 1 and 16 (both inclusive).",
            "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 0s & 1s of length 6 representing the enablement or disablement of the options associated with the Printer",
            "type":"string",
            "example":"000000"
        },
        "printerConfiguration":{
            "$ref":"#/definitions/PrinterConfiguration"
        }
    }
}

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 / 11

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

  Example: 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 / 11

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

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

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

  Example: /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 = 12

  Example: 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 / 14

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

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

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

  Example: 1

{
    "description":"An object containing the configuration settings for the printer",
    "type":"object",
    "properties":{
        "comPort":{
            "description":"The COM port for the printer. Applicable only if printerType = 1 / 6 / 7 / 8 / 9/ 10 / 12 / 14",
            "type":"string",
            "example":"COM4"
        },
        "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 (1/4) (58mm) Paper. Applicable only if printerType = 3 / 11",
            "type":"integer",
            "example":1
        },
        "firstPageMargins":{
            "$ref":"#/definitions/FirstPageMargins"
        },
        "otherPageMargins":{
            "$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":"123456789012345"
        }
    }
}

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

{
    "description":"Bluetooth settings",
    "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
        }
    }
}

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

{
    "description":"An object containing the Bluetooth configuration settings for the printer. Applicable only if printerType = 4",
    "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
        }
    }
}

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 device

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

  Example: 1
• printerId: integer
  The identifier of the printer

  Example: 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 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
        }
    }
}