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

Update User Model

Request

Path
idinteger>= 1required
Bodyapplication/json
emailstring
passwordstring
first_namestring
last_namestring
curl -i -X PUT \
  'https://docs.cognitivesystems.com/_mock/assets/specs/app-cloud/v1-5-x/users/{id}' \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -d '{
    "email": "string",
    "password": "string",
    "first_name": "string",
    "last_name": "string"
  }'

Responses

Bodyapplication/json
idinteger
usernamestring
emailstring
first_namestring
last_namestring
created_atstring
updated_atstring
confirmed_atstring or null
Response
application/json
{
  "id": 0,
  "username": "string",
  "email": "string",
  "first_name": "string",
  "last_name": "string",
  "created_at": "string",
  "updated_at": "string",
  "confirmed_at": "string"
}

Delete Confirmed User

Request

Path
idinteger>= 1required
Query
delete_claimed_networkboolean

Defaults to false. Delete the network associated with the user. If the user is a network owner, the network is completely deleted.

curl -i -X DELETE \
  'https://docs.cognitivesystems.com/_mock/assets/specs/app-cloud/v1-5-x/users/{id}?delete_claimed_network=true' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

Response
No content

Create Pending Invitation

Request

Sends an invite email to the provided list, the link in the email should take the invited users to the app, where they can create an account.

NOTE: Only the network owner may send Network Member Invites.

Bodyapplication/json
network_idstringrequired
emailsArray of stringsrequired
curl -i -X POST \
  https://docs.cognitivesystems.com/_mock/assets/specs/app-cloud/v1-5-x/member_invites \
  -H 'Content-Type: application/json' \
  -d '{
    "network_id": "string",
    "emails": [
      "string"
    ]
  }'

Responses

Bodyapplication/json
failed_emailsArray of strings
Response
application/json
{
  "failed_emails": [
    "string"
  ]
}

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