Home > Develop > IP Control > REST API > API List

getRemoteDeviceSettings (v1.0)

Estimated reading time: 1 minute

This API provides the current settings and supported settings related to remote devices, which can access the server device from outside the door.

Syntax

http://<Base URL>/system

Authentication Level

none

Request

params' Elements
An object composed of the following pair(s).
name type multiplicity default description
target string ? "" Target name. The default value is "". This indicates the settings of all targets. The client can get all remote device setting information by setting the empty string to "target". The client can get specific remote device setting values by explicitly setting the target name to "target".
  • "accessPermission" - Sets whether to permit access from remote devices, which can access the server device from outside the door.
  • "" - Settings of all targets.
 
{
    "method": "getRemoteDeviceSettings",
    "id": 44,
    "params": [{"target": "accessPermission"}],
    "version": "1.0"
}

Response

result's Elements
An array of objects composed of the following pairs.
name type multiplicity default description
target string 1 Target name.
  • "accessPermission" - Sets whether to permit access from remote devices, which can access the server device from outside the door.
currentValue string 1 Current value of the target.
  • If "target" is "accessPermission"
    • "on" - access is permitted.
    • "off" - access is not permitted.
JSON Example
{
    "result": [[{
        "currentValue": "on",
        "target": "accessPermission"
    }]],
    "id": 44
}
Error Code
No additional error codes are defined. Refer to error code for common errors.

Appendix

Guide about Response

  • The value for “currentValue” when the value for “target” is “accessPermission” indicates the remote start setting for BRAVIA Professional Display.
Last modified: 26 Jul 2024