CLI Reference Guide

Figure 3-13 Reset solution, success response example
3.3 Extensibility services
3.3.1 Set button
Table 3-16 Set button
?api=extensibility&method=setButton
POST Description Creates or modifies the Home screen button on the device. If any fields are not
specified, a default value will be used. If Embedded Capture had no button (silent
mode), it will change to a non-silent mode (interactive) after the button creation.
Icon requirements (*):
Authentication Requires basic authentication using device admin credentials.
Payload IN XML button details
OUT If 200, XML response with code 0
If 400, response with error code
Response Code 200 OK – success
400 Bad request:
Error code -3: Error parsing xml payload
Error code -10: Device is busy
Error code -12: Unexpected error
401 Unauthorized access – if basic authentication fails
411 Length required – if content length is not or is badly specified
500 Internal server error – if too many requests are active. Retry recommended.
Schema Request
?aspi=extensibility&rschema=setButton
Response
?api=common&rschema=default
20 Chapter 3 Compatible API