API reference - Ricoh Theta

camera._listAccessPoints command response on successful completion

Definitions
Type object

Examples:

{
    "results": {
        "accessPoints": [
            {
                "connectionPriority": 1,
                "defaultGateway": "192.168.100.1",
                "ipAddress": "192.168.100.10",
                "ipAddressAllocation": "static",
                "security": "WPA/WPA2 PSK",
                "ssid": "ssid0123",
                "ssidStealth": false,
                "subnetMask": "255.255.255.0"
            },
            {
                "connectionPriority": 2,
                "ipAddressAllocation": "dynamic",
                "security": "WPA/WPA2 PSK",
                "ssid": "ssidabcd",
                "ssidStealth": true,
                "_proxy": {
                    "use": true,
                    "url": "proxy.example.com",
                    "port": 8080,
                    "userid": "id012"
                }
            },
            {
                "connectionPriority": 3,
                "ipAddressAllocation": "dynamic",
                "security": "WPA/WPA2 PSK",
                "ssid": "ssidxyz",
                "ssidStealth": true
            }
        ]
    },
    "name": "camera._listAccessPoints",
    "state": "done"
}
{
    "results": {
        "accessPoints": []
    },
    "name": "camera._listAccessPoints",
    "state": "done"
}
Property Type Required Description
name const yes Executed command name
state const yes Command execution status
results object yes -

name

Definitions
Type const

Description: Executed command name

Specific value: "camera._listAccessPoints"

state

Definitions
Type const

Description: Command execution status

Specific value: "done"

results

Definitions
Type object
Property Type Required Description
accessPoints array yes List of the access points stored on Theta and the access points detected by Theta

accessPoints

Definitions
Type array

Description: List of the access points stored on Theta and the access points detected by Theta

Array restrictions
Min items N/A
Max items N/A
Each item of this array must be Description
accessPoint Access point settings

accessPoint

Definitions
Type object

Description: Access point settings

Property Type Required Description
ssid string yes SSID
ssidStealth boolean yes True if SSID stealth is enabled
security enum (of string) yes Authentication mode
connectionPriority integer yes Connection priority. One is the top priority.
ipAddressAllocation enum (of string) yes IP address allocation method. This can be acquired when SSID is registered as an enable access point.
ipAddress string no IP address assigned to Theta. This setting can be acquired when “ipAddressAllocation” is “static”
subnetMask string no Subnet Mask. This setting can be acquired when “ipAddressAllocation” is “static”
defaultGateway string no Default Gateway. This setting can be acquired when “ipAddressAllocation” is “static”
_proxy object no Proxy information to be used for the access point.
ssid
Definitions
Type string

Description: SSID

ssidStealth
Definitions
Type boolean

Description: True if SSID stealth is enabled

security
Definitions
Type enum (of string)

Description: Authentication mode

Must be one of:

connectionPriority
Definitions
Type integer

Description: Connection priority. One is the top priority.

Restrictions
Minimum ≥ 1
Maximum ≤ 5
ipAddressAllocation
Definitions
Type enum (of string)

Description: IP address allocation method. This can be acquired when SSID is registered as an enable access point.

Must be one of:

ipAddress
Definitions
Type string

Description: IP address assigned to Theta. This setting can be acquired when “ipAddressAllocation” is “static”

subnetMask
Definitions
Type string

Description: Subnet Mask. This setting can be acquired when “ipAddressAllocation” is “static”

defaultGateway
Definitions
Type string

Description: Default Gateway. This setting can be acquired when “ipAddressAllocation” is “static”

_proxy
Definitions
Type object

Description: Proxy information to be used for the access point.

Property Type Required Description
use boolean yes Use proxy if true
url string no Domain name or IP address of the proxy server
port integer no Port number of the proxy server
userid string no User ID used for proxy authentication
use
Definitions
Type boolean

Description: Use proxy if true

url
Definitions
Type string

Description: Domain name or IP address of the proxy server

port
Definitions
Type integer

Description: Port number of the proxy server

Restrictions
Minimum ≥ 1
Maximum ≤ 65535
userid
Definitions
Type string

Description: User ID used for proxy authentication