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

Sounding v2

Operations

Events, History, and Visualizations

Operations

Household Insights [BETA]

Operations

Zone Priority [BETA]

Operations

Universal Alerting

Operations

Meta

Operations

Administration

Operations

All Cached Networks

Request

This endpoint returns all network model stored in the app-cloud. Network models are stored in cache which can be made on-demand by setting ensure field to true. Default radius is 5km, if latitude and longitude is supplied with the request. Haversine Distance is used as distance metric to find networks.

Query
ensureboolean
radiusinteger
latitudenumber
longitudenumber
curl -i -X GET \
  'https://docs.cognitivesystems.com/_mock/assets/specs/app-cloud/v1-5-x/internal/network_map?ensure=true&latitude=0&longitude=0&radius=0' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

Bodyapplication/json
idinteger
namestring
created_atstring
updated_atstring
external_idinteger
user_countinteger
latitudestring
longitudestring
addressstring
timezonestring
pet_sizestring
building_typestring
building_sizestring
live_enabledboolean
scene_idinteger
Response
application/json
{
  "id": 0,
  "name": "string",
  "created_at": "string",
  "updated_at": "string",
  "external_id": 0,
  "user_count": 0,
  "latitude": "string",
  "longitude": "string",
  "address": "string",
  "timezone": "string",
  "pet_size": "string",
  "building_type": "string",
  "building_size": "string",
  "live_enabled": true,
  "scene_id": 0
}

Paginate Networks

Request

Retrieve paginated array of ALL networks in cloud.

Path
page_numberstringrequired

current page number

count_numberstringrequired

Number of items per page

Default 25
Query
onlineboolean

Filter returning networks by online status.

orderstring

Sort returning networks by network id

curl -i -X GET \
  'https://docs.cognitivesystems.com/_mock/assets/specs/app-cloud/v1-5-x/internal/networks/{page_number}/{count_number}?online=true&order=string' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

Bodyapplication/jsonArray [
network_idinteger
external_idinteger
network_namestring
onlineboolean
]
Response
application/json
[
  {
    "network_id": 1,
    "external_id": 219,
    "network_name": "wifi",
    "online": true
  },
  {
    "network_id": 2,
    "external_id": 2,
    "network_name": "99999",
    "online": true
  },
  {
    "network_id": 3,
    "external_id": 1028,
    "network_name": "Test",
    "online": true
  }
]

Invite new user

Request

Sends network invitation email to specified email for the given network.

Bodyapplication/json
network_idintegerrequired
Example: 3
emailstring(email)required
Example: "john.smith@cognitivesystems.com"
curl -i -X POST \
  https://docs.cognitivesystems.com/_mock/assets/specs/app-cloud/v1-5-x/internal/invite \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -d '{
    "network_id": 3,
    "email": "john.smith@cognitivesystems.com"
  }'

Responses

Bodyapplication/json
idinteger
Example: 1
network_idinteger
Example: 3
emailstring
Example: "john.smith@cognitivesystems.com"
created_atstring
Example: "2020-10-06T18:57:59.181Z"
updated_atstring
Example: "2020-10-06T18:57:59.181Z"
Response
application/json
{
  "id": 1,
  "network_id": 3,
  "email": "john.smith@cognitivesystems.com",
  "created_at": "2020-10-06T18:57:59.181Z",
  "updated_at": "2020-10-06T18:57:59.181Z"
}