Cognitive Systems WiFi Motion App-Cloud API (v1-5-x)

App Cloud APIs are used by mobile applications.

Download OpenAPI description
v1-5-x.json
v1-5-x.yaml
Languages
Servers
Mock server

https://docs.cognitivesystems.com/_mock/assets/specs/app-cloud/v1-5-x/

https://docs.cognitivesystems.com/api/v1/

Overview

Operations

Out of Box

Operations

Logging In

Operations

Geofencing

Operations

Account Management

Operations

Network Settings

Operations

Create Network Members

Request

Bodyapplication/json
rolestringrequired

"owner"

network_idintegerrequired
user_idintegerrequired
expandArray of strings
curl -i -X POST \
  https://docs.cognitivesystems.com/_mock/assets/specs/app-cloud/v1-5-x/network_memberships \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -d '{
    "role": "string",
    "network_id": 0,
    "user_id": 0,
    "expand": [
      "string"
    ]
  }'

Responses

Bodyapplication/json
idintegerrequired

Incremental App Cloud Id used internally for memberships

rolestringrequired

Users with 'owner' role have full access to a network, while 'member' users do not

Enum"owner""member"
userinteger or object
Any of:
integer
networkinteger or object
Any of:
integer
created_atstring(date-time)required
updated_atstring(date-time)required
is_presentboolean
Response
application/json
{
  "id": 0,
  "role": "owner",
  "user": 0,
  "network": 0,
  "created_at": "2019-08-24T14:15:22Z",
  "updated_at": "2019-08-24T14:15:22Z",
  "is_present": true
}

Show Scene Settings

Request

Path
idintegerrequired

network scene id

curl -i -X GET \
  'https://docs.cognitivesystems.com/_mock/assets/specs/app-cloud/v1-5-x/network_scene_configs/{id}' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

Bodyapplication/json
idinteger
excessive_motion_enabledboolean
excessive_motion_secondsinteger
network_idinteger
created_atstring
updated_atstring
auto_switching_enabledboolean
guardian_enabledboolean
guardian_weekday_start_time_hoursnumber
guardian_weekday_start_time_minutesnumber
guardian_weekday_end_time_hoursnumber
guardian_weekday_end_time_minutesnumber
guardian_weekend_start_time_hoursnumber
guardian_weekend_start_time_minutesnumber
guardian_weekend_end_time_hoursnumber
guardian_weekend_end_time_minutesnumber
Response
application/json
{
  "id": 0,
  "excessive_motion_enabled": true,
  "excessive_motion_seconds": 0,
  "network_id": 0,
  "created_at": "string",
  "updated_at": "string",
  "auto_switching_enabled": true,
  "guardian_enabled": true,
  "guardian_weekday_start_time_hours": 0,
  "guardian_weekday_start_time_minutes": 0,
  "guardian_weekday_end_time_hours": 0,
  "guardian_weekday_end_time_minutes": 0,
  "guardian_weekend_start_time_hours": 0,
  "guardian_weekend_start_time_minutes": 0,
  "guardian_weekend_end_time_hours": 0,
  "guardian_weekend_end_time_minutes": 0
}

Update Scene Settings

Request

Path
idintegerrequired

network scene id

Bodyapplication/json
idinteger
excessive_motion_secondsinteger
excessive_motion_enabledboolean
auto_switching_enabledboolean
guardian_enabledboolean
guardian_weekday_start_time_hoursnumber
guardian_weekday_start_time_minutesnumber
guardian_weekday_end_time_hoursnumber
guardian_weekday_end_time_minutesnumber
guardian_weekend_start_time_hoursnumber
guardian_weekend_start_time_minutesnumber
guardian_weekend_end_time_hoursnumber
guardian_weekend_end_time_minutesnumber
curl -i -X PUT \
  'https://docs.cognitivesystems.com/_mock/assets/specs/app-cloud/v1-5-x/network_scene_configs/{id}' \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -d '{
    "id": 0,
    "excessive_motion_seconds": 0,
    "excessive_motion_enabled": true,
    "auto_switching_enabled": true,
    "guardian_enabled": true,
    "guardian_weekday_start_time_hours": 0,
    "guardian_weekday_start_time_minutes": 0,
    "guardian_weekday_end_time_hours": 0,
    "guardian_weekday_end_time_minutes": 0,
    "guardian_weekend_start_time_hours": 0,
    "guardian_weekend_start_time_minutes": 0,
    "guardian_weekend_end_time_hours": 0,
    "guardian_weekend_end_time_minutes": 0
  }'

Responses

Bodyapplication/json
idinteger
excessive_motion_enabledboolean
excessive_motion_secondsinteger
network_idinteger
created_atstring
updated_atstring
auto_switching_enabledboolean
guardian_enabledboolean
guardian_weekday_start_time_hoursnumber
guardian_weekday_start_time_minutesnumber
guardian_weekday_end_time_hoursnumber
guardian_weekday_end_time_minutesnumber
guardian_weekend_start_time_hoursnumber
guardian_weekend_start_time_minutesnumber
guardian_weekend_end_time_hoursnumber
guardian_weekend_end_time_minutesnumber
Response
application/json
{
  "id": 0,
  "excessive_motion_enabled": true,
  "excessive_motion_seconds": 0,
  "network_id": 0,
  "created_at": "string",
  "updated_at": "string",
  "auto_switching_enabled": true,
  "guardian_enabled": true,
  "guardian_weekday_start_time_hours": 0,
  "guardian_weekday_start_time_minutes": 0,
  "guardian_weekday_end_time_hours": 0,
  "guardian_weekday_end_time_minutes": 0,
  "guardian_weekend_start_time_hours": 0,
  "guardian_weekend_start_time_minutes": 0,
  "guardian_weekend_end_time_hours": 0,
  "guardian_weekend_end_time_minutes": 0
}

Sounding v2

Operations

Events, History, and Visualizations

Operations

Household Insights [BETA]

Operations

Zone Priority [BETA]

Operations

Universal Alerting

Operations

Meta

Operations

Administration

Operations