POST /input

Default value: "application/json"

Information related to an Input request. It conveys the target input logical device, the type of input command, and possible minimum and maximum length of the input. In addition, if the requestor might require to receive an Event Notification if a card is inserted in a card reader, with the NotifyCardInputFlag.

Qualification of the information to send to an output logical device, to display or print to the Cashier or the Customer. Possible values:

• CustomerAssistance
• Display
• Document
• Error
• Input
• POIReplication
• Receipt
• Sound
• Status
• Voucher

Possible values:

• "CustomerAssistance"
• "Receipt"
• "POIReplication"
• "Error"
• "Input"
• "Status"
• "Document"
• "Sound"
• "Voucher"
• "Display"

Indicates whether to request an Immediate response to the message without waiting for the completion of the command.

Default value: false

Indicates that the user must confirm the entered characters, when the maximum allowed length is reached. During the processing of an Input command TextString, DigitString or DecimalString with MaxLength or MaxDecimalLength present in the request.

Default value: true

Type of requested input. Can be: GetConfirmation, TextString, DigitString, DecimalString or GetMenuEntry. Possible values:

• DecimalString
• DigitString
• GetAnyKey
• GetConfirmation
• GetFunctionKey
• GetMenuEntry
• Password
• SiteManager
• TextString

Possible values:

• "DecimalString"
• "GetFunctionKey"
• "GetMenuEntry"
• "Password"
• "TextString"
• "GetAnyKey"
• "SiteManager"
• "DigitString"
• "GetConfirmation"

Indicates if the entered character has to be displayed from the right to the left of the display field.

Default value: false

Indicates if the Valid function key has to be deactivated (value True). During the processing of an Input command GetConfirmation, SiteManager, or GetMenuEntry.

Default value: false

Indicates, when the user presses the Correct function key in an input entry, if all the entered characters are removed (value True) or only the last entered character if any (value False).

Default value: false

Request Notification of the card entered in the POI card reader.

Default value: false

Indicates if the Correct function key has to be deactivated (value True). During the processing of an Input command GetConfirmation, SiteManager, or GetMenuEntry.

Default value: false

Indicates, when the user press a key, if a beep has to be generated (value True).

Default value: false

Maximum length of an entered string, or maximum number of entries that can be selected in a menu.

String mask to get information requiring a specific format. For the processing of an Input command TextString, DigitString or DecimalString. Some information as date or plate number required to be entered with a certain format.

Indicates to mask the characters entered by the user (i.e. replacing in the display of the input, the entered character by a standard character as *).

Default value: false

Default string value for an input command. On the TextString, DigitString and DecimalString input commands: default string displayed on the input field before entering the string. In GetConfirmation input command: Y for yes, N for no.

If it has the value True, it indicates that the Back function key (respectively Home function key) may be used to go back to the immediate upper level of the menu. If it has the value False, it indicates that the current menu level has no parent menu.

Default value: false

Logical device located on a Sale Terminal or a POI Terminal, regarding the class of information to output (display, print or store), or input (keyboard) for the Cashier or the Customer. Possible values:

• CashierDisplay
• CashierInput
• CustomerDisplay
• CustomerInput

Possible values:

• "CashierDisplay"
• "CustomerInput"
• "CustomerDisplay"
• "CashierInput"

Maximum input time in seconds. Limits the time to answer to an Input request message.

Minimum length of an entered string, or minimum number of entries that can be selected in a menu.

Indicates if the Cancel function key has to be deactivated (value True).

Default value: false

Maximum input length of the decimal part (without decimal point).

Information to display and the way to process the display.

Qualification of the information to sent to an output logical device, to display or print to the Cashier or the Customer. Allows the manager of the device, Sale or POI Terminal, to send the information to a particular physical device or to present the information accordingly. Possible values:

• CustomerAssistance
• Display
• Document
• Error
• Input
• POIReplication
• Receipt
• Sound
• Status
• Voucher

Possible values:

• "CustomerAssistance"
• "Receipt"
• "POIReplication"
• "Error"
• "Input"
• "Status"
• "Document"
• "Sound"
• "Voucher"
• "Display"

Indicates if the message response is required.

Default value: true

Number of seconds the message has to be displayed.

Default value: 0

An entry of the menu to present to the Cashier. It conveys the message text and parameters of the menu entry. This output data could be only provided for an input command, in order to choose an entryof the menu.

Selection of a menu entry to be displayed. In Input request message, it allows selection of one or several menu entries before any user action.

Default value: false

Reference of a predefined message to display or print. It conveys information related to the predefined message.

Identification of a language.

Identification of a predefined message to display or print.

Characteristics related to the selection of a menu entry. Possible values:

• NonSelectable
• NonSelectableSubMenu
• Selectable
• SubMenu

Possible values:

• "NonSelectable"
• "Selectable"
• "NonSelectableSubMenu"
• "SubMenu"

Content of text message to display or print. It conveys Information related to the content of the text message and its format. All the data elements related to the format of the text to display or print are parameters valid for the whole Text content.

Indicates if the text is at the end of a line. Allows the display or the print of a new line and a carry-over return characters after the formatted text.

Default value: true

Content of text message to display, print or play.

Name of the font. Used to change character font of the output, as agreed between the POI and Sale Systems.

Character height of the text string to display or print. Absence of this data element means the characters have normal height. Possible values:

• DoubleHeight
• HalfHeight
• SingleHeight

Possible values:

• "HalfHeight"
• "SingleHeight"
• "DoubleHeight"

Alignment of the text string on the display line or print line. Absence of this data element means the characters have normal alignment. Possible values:

• Centred
• Justified
• Left
• Right

Possible values:

• "Right"
• "Justified"
• "Left"
• "Centred"

Column where the text string has to be displayed or printed.

Character height of the text string to display or print. Absence of this data element means the characters have normal height.

Row where the text string has to be displayed or printed.

Character width of the text string to display or print. Absence of this data element means the characters have normal width. Possible values:

• DoubleWidth
• SingleWidth

Possible values:

• "SingleWidth"
• "DoubleWidth"

Typographic style of the sequence of characters to display or print. Absence of this data element means the characters have normal style. Possible values:

• Bold
• Italic
• Normal
• Underline

Possible values:

• "Bold"
• "Normal"
• "Underline"
• "Italic"

Color of the text string to display or print. Possible values:

• Black
• Blue
• Cyan
• Green
• Magenta
• Red
• White
• Yellow

Possible values:

• "Cyan"
• "Green"
• "Black"
• "Red"
• "Magenta"
• "Yellow"
• "Blue"
• "White"

XHTML document body containing the message to display or print.

Possible values:

• BarCode
• MessageRef
• Text
• XHTML

Possible values:

• "MessageRef"
• "Text"
• "BarCode"
• "XHTML"

Vendor-specific signature of the text message to display or print. If protection has to be provided to the vendor on the text to display or print.

Logical device located on a Sale Terminal or a POI Terminal, in terms of class of information to output (display, print, or store), or input (keyboard) for the Cashier or the Customer. Possible values:

• CashierDisplay
• CashierInput
• CustomerDisplay
• CustomerInput

Possible values:

• "CashierDisplay"
• "CustomerInput"
• "CustomerDisplay"
• "CashierInput"

Content to display or print.

Reference of a predefined message to display or print. Mandatory, if OutputFormat is MessageRef, not allowed otherwise.

Identification of a language.

Identification of a predefined message to display or print.

Barcode content to display or print. Mandatory if OutputFormat is Barcode, not allowed otherwise.

Value with a Barcode coding. The barcode value to display or print.

Type of Barcode coding. Qualification of the barcode value to display or print. Possible values:

• Code128
• Code25
• EAN13
• EAN8
• PDF417
• QRCode
• UPCA

Possible values:

• "QRCode"
• "UPCA"
• "Code25"
• "EAN8"
• "EAN13"
• "Code128"
• "PDF417"

Content of text message to display or print. Mandatory, if OutputFormat is Text, not allowed otherwise. One instance of OutputText per shared format.

Indicates if the text is at the end of a line. Allows the display or the print of a new line and a carry-over return characters after the formatted text.

Default value: true

Content of text message to display, print or play.

Name of the font. Used to change character font of the output, as agreed between the POI and Sale Systems.

Character height of the text string to display or print. Absence of this data element means the characters have normal height. Possible values:

• DoubleHeight
• HalfHeight
• SingleHeight

Possible values:

• "HalfHeight"
• "SingleHeight"
• "DoubleHeight"

Alignment of the text string on the display line or print line. Absence of this data element means the characters have normal alignment. Possible values:

• Centred
• Justified
• Left
• Right

Possible values:

• "Right"
• "Justified"
• "Left"
• "Centred"

Column where the text string has to be displayed or printed.

Character height of the text string to display or print. Absence of this data element means the characters have normal height.

Row where the text string has to be displayed or printed.

Character width of the text string to display or print. Absence of this data element means the characters have normal width. Possible values:

• DoubleWidth
• SingleWidth

Possible values:

• "SingleWidth"
• "DoubleWidth"

Typographic style of the sequence of characters to display or print. Absence of this data element means the characters have normal style. Possible values:

• Bold
• Italic
• Normal
• Underline

Possible values:

• "Bold"
• "Normal"
• "Underline"
• "Italic"

Color of the text string to display or print. Possible values:

• Black
• Blue
• Cyan
• Green
• Magenta
• Red
• White
• Yellow

Possible values:

• "Cyan"
• "Green"
• "Black"
• "Red"
• "Magenta"
• "Yellow"
• "Blue"
• "White"

XHTML document body containing the message to display or print. Mandatory if OutputFormat is XHTML, not allowed otherwise.

Format of the content to display or print. Possible values:

• BarCode
• MessageRef
• Text
• XHTML

Possible values:

• "MessageRef"
• "Text"
• "BarCode"
• "XHTML"