Home >
Develop >
IP Control >
REST API > API List
getWebAppStatus (v1.0)
Estimated reading time:
1 minute
- This API provides functions to retrieve the status of WebAppRuntime and to retrieve the URL of the current webpage to open on WebApp.
Syntax
- http://<Base URL>/appControl
Authentication Level
- private
Request
- params' Elements
- Not necessary.
- JSON Example
-
{
"method": "getWebAppStatus",
"id": 1,
"params": [],
"version": "1.0"
}
Response
- result's Elements
- An array of objects composed by following pairs.
| name |
type |
multiplicity |
default |
description |
| active |
boolean |
1 |
|
WebAppRuntime application status.
- "true" - active.
- "false" - inactive.
|
| url |
string |
? |
"" |
The URL of the current webpage to open on WebApp |
- JSON Example
-
{
"result": [{
"active": true,
"url": "http://example.com/"
}],
"id": 1
}
- Error Code
- Following error codes are important for this API. Refer to error code for other errors.
| code |
Explanation |
| 7 |
Device is in the power off state.
|
Last modified: 26 Jul 2024