UI Request

Limited functionality

This request is only available on the APOLLO terminal family.

Header	Length	Data
0x28	0x00	UI Type Null terminated string Repeated 'N' times: Key Null terminated string Value Null terminated string

Usage

• This command can be used to request a UI to be shown on the terminal. The request contains the ID of a UI Type and a list of key/value pairs for all parameters for that UI.

Supported UI Types

• info - a general purpose screen to display information to the user
• notification - used to inform the user of the outcome of an action
• dialog - used to display a small result message with the option to add one or two buttons for customer interaction
• selection - used to provide a list of items from which the user can select
• spinner - a general purpose progress indication to screen to indicate the application is processing a request
• carousel - a general purpose starting screen.

More information on these screens can be found in the dedicated UI documentation. Commands will need to be converted from the CURL/JSON content to the Key/Value format described in the table above.

Response

Result

Some UI Request commands may result in an UI Event being returned at some point. This response is triggered by human interaction however, so is not a direct response to the UI Request command.