setPowerStatus (v1.0)

Estimated reading time: 1 minute

This API provides the function to change the current power status of the device.

Syntax

http://<Base URL>/system

Authentication Level

generic

Request

params' Elements
An object composed of the following pair(s).
name type multiplicity default description
status boolean 1 Power status.
  • true - indicates the power on state.
  • false - indicates the power off state.
JSON Example
{
    "method": "setPowerStatus",
    "id": 55,
    "params": [{"status": false}],
    "version": "1.0"
}

Response

result's Elements
Not necessary.
JSON Example
{
    "result": [],
    "id": 55
}
Error Code
No additional error codes are defined. Refer to error code for common errors.

Appendix

  • The power-on request is supported only in “Sleep” mode. Refer to here to know “Sleep” in detail.
  • If the Remote start setting (Settings - Network) is OFF, an error is received form the client when caling SetPowerStatus(ON).
Last modified: 6 Mar 2019