Sensaphone.net API/dashboard - Revision history

Derek: /* Example */

2017-09-07T21:14:05Z

‎Example

Derek at 20:50, 7 September 2017

2017-09-07T20:50:58Z

Tim: /* GET */

2015-04-30T17:17:47Z

‎GET

Tim: /* Example */

2015-04-30T17:16:58Z

‎Example

Tim: /* GET */

2015-04-30T17:15:45Z

‎GET

Tim: /* Sensaphone.net API */

2015-04-30T15:54:20Z

‎Sensaphone.net API

Tim: Created page with "=Sensaphone.net API= Receive data to populate Dashboard. The Dashboard is a page that gives the user a quick view of Device and alarm statuses. It is a read only resource..."

2015-04-29T18:17:55Z

Created page with "=Sensaphone.net API= Receive data to populate Dashboard. The Dashboard is a page that gives the user a quick view of Device and alarm statuses. It is a read only resource..."

New page

=[[Sensaphone.net API]]=

Receive data to populate Dashboard. The Dashboard is a page that gives the user a quick view of Device and alarm statuses. It is a read only resource.

==Example Call==

http://rest.sensaphone.net/api/v1/{ACCTID}/{UUID}/dashboard

==Values==
*User's First and Last name
*Units Online
*Current Alarms
*Unacknowledged Alarms
*Battery Level

==Example Requests==
===GET===
'''URI Mode Request URI's:'''
*Receive all Dashboard information
'''GET''' https://rest.sensaphone.net/api/v1/{ACCTID}/{UUID}/dashboard

*Receive for the number of Devices online
'''GET''' https://rest.sensaphone.net/api/v1/{ACCTID}/{UUID}/dashboard/devices_online

*Receive the names of all Devices powered on and online
'''GET''' https://rest.sensaphone.net/api/v1/{ACCTID}/{UUID}/dashboard/device/name
'''JSON Mode Request URI:'''
'''POST''' https://rest.sensaphone.net/api/v1/dashboard

'''JSON Mode Request Properties'''
{{TableStart|border_size=1
}}{{TableRowN| '''Parent Property'''|'''Child Property''' |'''Type''' | '''Description'''
}}{{TableRowN|   | acctid | Integer | Account ID
}}{{TableRowN|   | session | Integer | Session ID
}}{{TableRowN|   | request_type | String | "read"
}}{{TableRowN|   | dashboard | Object | The dashboard object.
}}{{TableEnd}}
<br>
'''JSON Mode Response Properties'''
{{TableStart|border_size=1
}}{{TableRowN| '''Parent Property''' |'''Child Property'''|'''Status'''| '''Type''' | '''Description'''
}}{{TableRowN|   | dashboard | Required | Object | The dashboard object.
}}{{TableRowN| dashboard | name | Optional | String | Name of account holder
}}{{TableRowN| dashboard | devices_online | Optional | Integer | Number of Devices turned on and online
}}{{TableRowN| dashboard | unacknowledged_alarms | Optional | Integer | Number of unacknowledged alarms
}}{{TableRowN| dashboard | device | Optional | Array | Array of Devices
}}{{TableRowN| device | device_id | Optional | Integer | ID of Device
}}{{TableRowN| device | id | Optional | Integer | Unique identifier located on the Device (Serial number, etc.)
}}{{TableRowN| device | name | Optional | String | Name of Device
}}{{TableRowN| device | status | Optional | String | Alarm status of Device("OK" or "Alarm")
}}{{TableRowN| device | is_offline_unack | Optional | Boolean | Whether or not an '''unacknowledged''' offline alarm exists.
}}{{TableRowN| device | is_online | Optional | Boolean | Whether or not the device is currently online.
}}{{TableRowN| device | battery_status | Optional | String | A device's battery status
}}{{TableRowN| device | power_status | Optional | String | A device's power status
}}{{TableRowN| device | battery_value | Optional | String | A device's battery value
}}{{TableRowN| device | power_value | Optional | String | A device's power value
}}{{TableRowN| device | connection_status | Optional | String | A device's connection status
}}{{TableEnd}}

====Example====
This example is requesting the '''devices_online''' and '''name''' values.

*'''Request JSON'''
{
"request_type":"read",
"resource":"dashboard",
"acctid":987654,
"uuid":"0123-4567-8901",
"devices_online": null,
"device":
{
"name":null
}
}

*'''Result JSON'''

{
"result":
{
"success":true,
"code":0,
"message":"OK:,
},
"response":
{
"devices_online":3,
"device":
{
"name":"Device 1",
"name":"Device 2",
"name":"Device 3"
}
}
}

@@ Line 68: / Line 68: @@
 *'''Request JSON'''
-−
+{
-     "request_type":"read",
+     "request_type": "read",
-     "resource":"dashboard",
+     "resource": "dashboard",
-     "acctid":987654,
+     "acctid": 12345678,
-     "session":"0123-4567-8901",
+     "session": "123a-456b-789c",
-     "online_count": null,
+     "dashboard": {
-    "device":
+        "online_count": null,
+        "device": [{
-        "name":null
+            "name": null
+        }]
-−
+    }
 *'''Result JSON'''
-−
+{
-     "result":
+     "response": {
+        "dashboard": {
-       "success":true,
+            "device": [
-       "code":0,
-       "message":"OK:,
+                    "device_id": 9876,
-      },
+                    "name": "A device"
-     "response":
+                },
-−
+                {
-        "online_count":3,
+                    "device_id": 5432,
-        "device":
+                    "name": "Another device"
-−
+                }
-             "name":"Device 1",
+            ],
-             "name":"Device 2",
+            "online_count": 2
-             "name":"Device 3"
+    },
+    "result": {
+        "code": 0,

@@ Line 54: / Line 54: @@
 }}{{TableRowN| device                | power_value    | Optional       | String    | A device's power value
 }}{{TableRowN| device                | connection_status    | Optional       | String    | A device's connection status
-}}{{TableRowN| device                | zone               | Optional   | Array of Objects | Device Zone data (See [[Sensaphone.net API/zone|Sensaphone.net API/zone]])
+}}{{TableRowN| device                | zone               | Optional   | Array of Objects | Device Zone data (See [[Sensaphone.net API/zone|Sensaphone.net API/zone]]) *Only returns zones with an alarm
 }}{{TableRowN| zone                  | canonical_name        | Optional   | String  | Canonical name of the zone.
 }}{{TableRowN| zone                  | value              | Optional   | String           | The data value for the zone.

← Older revision		Revision as of 15:54, 30 April 2015
Line 6:		Line 6:

	http://rest.sensaphone.net/api/v1/{ACCTID}/{UUID}/dashboard		http://rest.sensaphone.net/api/v1/{ACCTID}/{UUID}/dashboard
−
−	~~==Values==~~
−	*User's First and Last name
−	*Units Online
−	*Current Alarms
−	*Unacknowledged Alarms
−	*Battery Level

	==Example Requests==		==Example Requests==

@@ Line 25: / Line 25: @@
 }}{{TableRowN| '''Parent Property'''|'''Child Property''' |'''Type'''        | '''Description'''
 }}{{TableRowN| &nbsp;          | acctid                   | Integer          | Account ID
-}}{{TableRowN| &nbsp;          | session                  | Integer          | Session ID
+}}{{TableRowN| &nbsp;          | session                  | String           | Session ID
 }}{{TableRowN| &nbsp;          | request_type             | String           | "read"
 }}{{TableRowN| &nbsp;          | dashboard                   | Object | The dashboard object.

@@ Line 34: / Line 34: @@
 }}{{TableRowN| '''Parent Property''' |'''Child Property'''|'''Status'''| '''Type'''       | '''Description'''
 }}{{TableRowN| &nbsp;                | dashboard             | Required   | Object | The dashboard object.
-}}{{TableRowN| dashboard           | name                                | Optional    | String     | Name of account holder
+}}{{TableRowN| dashboard           | online_count                  | Optional    | Integer    | Number of Devices turned on and online
-}}{{TableRowN| dashboard           | devices_online                  | Optional    | Integer    | Number of Devices turned on and online
+}}{{TableRowN| dashboard           | offline_count                  | Optional    | Integer    | Number of Devices offline
-}}{{TableRowN| dashboard           |  unacknowledged_alarms   | Optional    | Integer    | Number of unacknowledged alarms
+}}{{TableRowN| dashboard           |  alarm_count   | Optional    | Integer    | Number of acknowledged alarms
 }}{{TableRowN| dashboard           |  device                              | Optional     | Array      | Array of Devices
 }}{{TableRowN| device                | device_id          | Optional   | Integer          | ID of Device
 }}{{TableRowN| device                | id                 | Optional   | Integer          | Unique identifier located on the Device (Serial number, etc.)
 }}{{TableRowN| device                | name               | Optional   | String           | Name of Device
 }}{{TableRowN| device                | status        | Optional   | String           | Alarm status of Device("OK" or "Alarm")
 }}{{TableRowN| device                | is_offline_unack   | Optional   | Boolean          | Whether or not an '''unacknowledged''' offline alarm exists.
@@ Line 49: / Line 54: @@
 }}{{TableRowN| device                | power_value    | Optional       | String    | A device's power value
 }}{{TableRowN| device                | connection_status    | Optional       | String    | A device's connection status
 }}{{TableEnd}}