https://wiki.sensaphone.net/api.php?action=feedcontributions&feedformat=atom&user=Derek
Sensaphone.net - User contributions [en]
2026-05-10T16:11:54Z
User contributions
MediaWiki 1.24.1
https://wiki.sensaphone.net/index.php?title=Sensaphone.net_API/login&diff=176
Sensaphone.net API/login
2018-01-05T20:38:02Z
<p>Derek: /* Example Call */</p>
<hr />
<div>=[[Sensaphone.net API]]=<br />
<br />
The Login API will be used to log in to the Sensaphone.net system. When a user logs in with their username and password they will be assigned a session UUID. The session UUID will have a corresponding time stamp and a timed expiration for their session. The session UUID and statically assigned Account ID will be used as the primary identifier instead of including a username and password in subsequent URI requests. <br />
<br />
==Example Call==<br />
https://rest.sensaphone.net/api/v1/login/{USERNAME}/{PASSWORD}<br />
<br />
==Values==<br />
*Username<br />
*Password<br />
*Session UUID<br />
*Session Time stamp<br />
*Session Expiration<br />
<br />
==Example Requests==<br />
===GET===<br />
'''URI Mode Request URI's:'''<br />
*Receive Login information <br />
'''GET''' https://rest.sensaphone.net/api/v1/{ACCTID}/{SESSION}/login<br />
*Receive a Login timestamp for a session <br />
'''GET''' https://rest.sensaphone.net/api/v1/{ACCTID}/{SESSION}/login/login_timestamp<br />
*Receive the number of seconds until a session expires <br />
'''GET''' https://rest.sensaphone.net/api/v1/{ACCTID}/{SESSION}/login/session_expiration <br />
<br />
'''JSON MODE Request URI:'''<br />
*Receive Login information <br />
'''POST''' https://rest.sensaphone.net/api/v1/login<br />
<br />
{{TableStart|border_size=1<br />
}}{{TableRowN| '''Request Property''' | '''Status''' | '''Type''' | '''Description'''<br />
}}{{TableRowN| acctid | Required | Integer | Static ID of user<br />
}}{{TableRowN| session | Required | Integer | Session ID of user<br />
}}{{TableEnd}}<br />
<br><br />
{{TableStart|border_size=1<br />
}}{{TableRowN| '''Response Property''' | '''Included''' | '''Type''' | '''Description'''<br />
}}{{TableRowN| login_timestamp | Optional | String | Time stamp of last log in<br />
}}{{TableRowN| session_expiration | Optional | Integer | Seconds until log in expiration<br />
}}{{TableRowN| user_id | Optional | Integer | ID of the logged in user<br />
}}{{TableEnd}}<br />
<br />
====Example JSON====<br />
Log in with a username and password using JSON mode.<br />
*'''Request JSON:'''<br />
{<br />
"request_type":"create",<br />
"resource": "login",<br />
"user_name": "myusername",<br />
"password": "pass123"<br />
}<br />
<br />
*'''Response JSON:'''<br />
{<br />
"result": {<br />
"success": true,<br />
"code": 0,<br />
"message": "Success"<br />
},<br />
"response": {<br />
"acctid": 987654,<br />
"session": "0123-4567-8901",<br />
"login_timestamp": 1499459402,<br />
"session_expiration": 86400,<br />
"user_id": 00000001<br />
}<br />
}<br />
<br />
Receive Login information for a given session UUID.<br />
<br />
*'''Request JSON:'''<br />
{<br />
"request_type:"read",<br />
"resource":"login",<br />
"acctid":987654,<br />
"session":"0123-4567-8901",<br />
"login":null<br />
}<br />
<br />
*'''Response JSON:'''<br />
{<br />
"result":<br />
{<br />
"success: true,<br />
"code": 0,<br />
"message":"OK",<br />
},<br />
"response":<br />
{<br />
"login_timestamp":"2014-12-31 23:59:59",<br />
"session_expiration":60<br />
}<br />
}<br />
<br />
===PUT===<br />
PUT will be used only to update a Login session.<br />
<br />
'''URI Mode Request URI:'''<br />
*Request to update a Login session <br />
'''PUT''' https://rest.sensaphone.net/api/v1/{ACCTID}/{SESSION}/login<br />
'''JSON Mode Request URI:'''<br />
'''POST''' https://rest.sensaphone.net/api/v1/login<br />
<br />
{{TableStart|border_size=1<br />
}}{{TableRowN| '''Request Property''' | '''Status''' | '''Type''' | '''Description'''<br />
}}{{TableRowN| acctid | Required | Integer | Static ID of user<br />
}}{{TableRowN| session | Required | Integer | Session ID of user<br />
}}{{TableRowN| user_name | Optional | String | Username<br />
}}{{TableRowN| password | Optional | String | Password for username<br />
}}{{TableEnd}}<br />
<br><br />
{{TableStart|border_size=1<br />
}}{{TableRowN| '''Response Property''' | '''Included''' | '''Type''' | '''Description'''<br />
}}{{TableRowN| acctid | Conditionally* | Integer | Static ID of user<br />
}}{{TableRowN| session | Conditionally* | Integer | Session ID of user<br />
}}{{TableRowN| login_timestamp | Always | Integer | Time stamp of renewed session<br />
}}{{TableRowN| session_expiration | Always | Integer | Time until new log in session expiration<br />
}}{{TableRowN| user_id | Always | Integer | ID of the logged in user<br />
}}{{TableEnd}}<br />
<nowiki>*</nowiki> There may be an instance where the system needs to create a new Session ID and/or Account ID. In which case, it will be outputted in the PUT response.<br />
<br />
===POST===<br />
'''URI Mode Request URI:'''<br />
*Request for creating a new login session <br />
'''POST''' https://rest.sensaphone.net/api/v1/login/{USERNAME}/{PASSWORD}<br />
'''JSON Mode Request URI:'''<br />
'''POST''' https://rest.sensaphone.net/api/v1/login<br />
<br />
{{TableStart|border_size=1<br />
}}{{TableRowN| '''Request Property''' | '''Status''' | '''Type''' | '''Description'''<br />
}}{{TableRowN| user_name | Required | String | Username<br />
}}{{TableRowN| password | Required | String | Password for username<br />
}}{{TableEnd}}<br />
<br><br />
{{TableStart|border_size=1<br />
}}{{TableRowN| '''Response Property''' | '''Type''' | '''Description'''<br />
}}{{TableRowN| acctid | Integer | Static ID of user<br />
}}{{TableRowN| session | Integer | Session ID of user<br />
}}{{TableRowN| login_timestamp | Integer | Time stamp of renewed session<br />
}}{{TableRowN| session_expiration | Integer | Time until new log in expiration<br />
}}{{TableRowN| user_id | Integer | ID of the logged in user<br />
}}{{TableEnd}}<br />
<br />
===DELETE===<br />
Deleting a login session is the equivalent to logging out. <br />
<br />
'''URI Mode Request URI:'''<br />
*Request to log out of a session <br />
'''DELETE''' https://rest.sensaphone.net/api/v1/{ACCTID}/{SESSION}/login<br />
'''JSON Mode Request URI:'''<br />
'''POST''' https://rest.sensaphone.net/api/v1/login<br />
<br />
{{TableStart|border_size=1<br />
}}{{TableRowN| '''Request Property''' | '''Status''' | '''Type''' | '''Description'''<br />
}}{{TableRowN| acctid | Required | Integer | Static ID of user<br />
}}{{TableRowN| session | Required | Integer | Session ID of user<br />
}}{{TableEnd}}<br />
<br />
==Future==<br />
In the future the login process will support OAuth for advanced access and authentication.<br />
<br />
==Password Reset==<br />
To reset a pass for a particular email, use the following request:<br />
<br />
'''POST''' https://rest.sensaphone.net/api/v1/login/reset_password/{email_address}</div>
Derek
https://wiki.sensaphone.net/index.php?title=Sensaphone.net_API/history&diff=175
Sensaphone.net API/history
2017-10-25T14:52:39Z
<p>Derek: /* Event Log */</p>
<hr />
<div>=[[Sensaphone.net API]]=<br />
<br />
<br />
==Access==<br />
The History API allows access to the Audit Log, the Data Log, and the Event Log<br />
<br />
==Specifications==<br />
The URI Mode for the History API is unique because it allows filtering options to be specified in pairs and can be added in any order. Also, the array values are expressed as a common-separated list.<br />
/history/audit_log/var_ids/{1234,9876}/changes/{create}<br />
<br />
==Timestamps==<br />
The history APIs such as the Data Log use Sensaphone encoded timestamps. This allows the timestamps to be independent of the time zone of the client request, and return results adjusted to the time zone of the device, account, etc. Seconds, minutes, hours, days, and months are 0-indexed, in other words the range of month values is [0,11]. The year value is 2000-based and limited to 100 years.<br />
<br />
In order to create a Sensaphone timestamp given the year, month, day, hours, minutes, and seconds, convert each parameter to its equivalent value in seconds. For the example, in pseudo-code, a factory method would look as following:<br />
<br />
getSensaphoneTimestamp( year, month, day, hours, minutes, seconds ) {<br />
return ((seconds % 60)) +<br />
((minutes * 60) % 3600) +<br />
((hours * 3600) % 86400) +<br />
((day * 86400) % 2678400) + <br />
((month * 2678400) % 32140800) + <br />
((year % 100 * 32140800)); <br />
}<br />
<br />
==Audit Log==<br />
<br />
<br />
'''Audit Log Filter Options'''<br />
{{TableStart|border_size=1<br />
}}{{TableRowN| '''Property''' |'''Status''' | '''Type''' | '''Description'''<br />
}}{{TableRowN| var_ids | Optional | Array of Integer | list of variable ids <br />
}}{{TableRowN| user_ids | Optional | Array of Integer | list of user ids<br />
}}{{TableRowN| changes | Optional | Array of String | list of change types ("create","delete","update")<br />
}}{{TableRowN| start | Optional | Integer | the start time (Sensaphone timestamp)<br />
}}{{TableRowN| end | Optional | Integer | the end time (Sensaphone timestamp)<br />
}}{{TableRowN| begin_offset | Optional | Integer | the beginning offset of the first record<br />
}}{{TableRowN| record_offset | Optional | Integer | the offset from the beginning<br />
}}{{TableEnd}}<br />
<br />
===GET===<br />
<br />
'''Audit Log Request Properties'''<br />
{{TableStart|border_size=1<br />
}}{{TableRowN| '''Parent Property''' |'''Child Property'''| '''Type''' | '''Description'''<br />
}}{{TableRowN| &nbsp; | acctid | Integer | Account ID<br />
}}{{TableRowN| &nbsp; | session | String | Session ID<br />
}}{{TableRowN| &nbsp; | request_type | String | "read"<br />
}}{{TableRowN| &nbsp; | history | Object | The History object<br />
}}{{TableRowN| history | audit_log | Object | Audit Log Filter Options<br />
}}{{TableEnd}}<br />
<br />
'''Audit Log Response Properties'''<br />
{{TableStart|border_size=1<br />
}}{{TableRowN| '''Parent Property''' |'''Child Property'''| '''Type''' | '''Description'''<br />
}}{{TableRowN| &nbsp; | history | Object | The history object<br />
}}{{TableRowN| history | audit_log | Array of Objects | The returned log<br />
}}{{TableRowN| audit_log | change | String | The change that occurred<br />
}}{{TableRowN| audit_log | who | String | Who changed it<br />
}}{{TableRowN| audit_log | what | String | What changed<br />
}}{{TableRowN| audit_log | when | String | When it changed<br />
}}{{TableRowN| audit_log | epoch | Integer | The epoch time<br />
}}{{TableRowN| history | audit_log_filter | Object | Audit Log Filter Options (Only returned in V2)<br />
}}{{TableEnd}}<br />
<br />
*Receive all changes for a variable:<br />
*'''URI Mode:'''<br />
'''GET''' https://rest.sensaphone.net/api/v1/{ACCOUNT}/{SESSION}/history/audit_log/var_ids/{1234}<br />
<br />
*'''JSON Mode:'''<br />
'''POST''' https://rest.sensaphone.net/api/v1/{ACCOUNT}/{SESSION}/history/audit_log/<br />
<br />
{<br />
"request_type": "read",<br />
"history":<br />
{<br />
"audit_log": {<br />
"var_ids" : [1234]<br />
}<br />
}<br />
}<br />
<br />
==Data Log==<br />
<br />
<br />
'''Data Log Filter Options'''<br />
{{TableStart|border_size=1<br />
}}{{TableRowN| '''Property''' |'''Status''' | '''Type''' | '''Description'''<br />
}}{{TableRowN| log_points | Optional | Array of Integer | list of variable ids <br />
}}{{TableRowN| status | Optional | Array of String | list of AlarmStatus ("normal", "dependency", "alarm")<br />
}}{{TableRowN| start | Optional | Integer | the start time (Sensaphone timestamp)<br />
}}{{TableRowN| end | Optional | Integer | the end time (Sensaphone timestamp)<br />
}}{{TableRowN| begin_offset | Optional | Integer | the beginning offset of the first record<br />
}}{{TableRowN| record_offset | Optional | Integer | the offset from the beginning<br />
}}{{TableEnd}}<br />
<br />
===GET===<br />
<br />
'''Data Log Request Properties'''<br />
{{TableStart|border_size=1<br />
}}{{TableRowN| '''Parent Property''' |'''Child Property'''| '''Type''' | '''Description'''<br />
}}{{TableRowN| &nbsp; | acctid | Integer | Account ID<br />
}}{{TableRowN| &nbsp; | session | String | Session ID<br />
}}{{TableRowN| &nbsp; | request_type | String | "read"<br />
}}{{TableRowN| &nbsp; | history | Object | The History object<br />
}}{{TableRowN| history | data_log | Object | Data Log Filter Options<br />
}}{{TableEnd}}<br />
<br />
'''Data Log Response Properties'''<br />
{{TableStart|border_size=1<br />
}}{{TableRowN| '''Parent Property''' |'''Child Property'''| '''Type''' | '''Description'''<br />
}}{{TableRowN| &nbsp; | history | Object | The history object<br />
}}{{TableRowN| history | data_log | Array of Objects | The returned log<br />
}}{{TableRowN| data_log | record_id | String | The id of the record<br />
}}{{TableRowN| data_log | value | String | The value of the variable<br />
}}{{TableRowN| data_log | variable | String | The variable id<br />
}}{{TableRowN| data_log | is_alarm | String | Is an alarm<br />
}}{{TableRowN| data_log | epoch | Integer | The epoch time<br />
}}{{TableRowN| history | data_log_filter | Object | Audit Log Filter Options (Only returned in V2)<br />
}}{{TableEnd}}<br />
<br />
*Receive the last 50 logged datas for a log point<br />
*'''URI Mode:'''<br />
'''GET''' https://rest.sensaphone.net/api/v1/{ACCOUNT}/{SESSION}/history/data_log/log_points/{1234}/begin_offset/{0}/record_offset/{50}<br />
<br />
<br />
*'''JSON Mode:'''<br />
'''POST''' https://rest.sensaphone.net/api/v1/{ACCOUNT}/{SESSION}/history/data_log<br />
<br />
{<br />
"request_type": "read",<br />
"history":<br />
{<br />
"data_log": {<br />
"log_points" : [1234],<br />
"begin_offset" : 0,<br />
"record_offset" : 50<br />
}<br />
}<br />
}<br />
<br />
==Data Log Points==<br />
Poll the Data Log Points to get the possible logable points to use for the Data Log<br />
<br />
===GET===<br />
<br />
'''Data Log Points Request Properties'''<br />
{{TableStart|border_size=1<br />
}}{{TableRowN| '''Parent Property''' |'''Child Property'''| '''Type''' | '''Description'''<br />
}}{{TableRowN| &nbsp; | acctid | Integer | Account ID<br />
}}{{TableRowN| &nbsp; | session | String | Session ID<br />
}}{{TableRowN| &nbsp; | request_type | String | "read"<br />
}}{{TableRowN| &nbsp; | history | Object | The History object<br />
}}{{TableRowN| history | data_log_points | Object | <br />
}}{{TableRowN| data_log_points | resource_type | String | the name of the resource, e.g. "device"<br />
}}{{TableRowN| data_log_points | (id_name) | Integer | The ID of the resource, e.g. "device_id"<br />
}}{{TableEnd}}<br />
<br />
'''Data Log Points Response Properties'''<br />
{{TableStart|border_size=1<br />
}}{{TableRowN| '''Parent Property''' |'''Child Property'''| '''Type''' | '''Description'''<br />
}}{{TableRowN| &nbsp; | history | Object | The history object<br />
}}{{TableRowN| history | data_log_points | Object | The returned log<br />
}}{{TableRowN| data_log_points | resource_type | String | the name of the resource, e.g. "device"<br />
}}{{TableRowN| data_log_points | (id_name) | Integer | The ID of the resource, e.g. "device_id"<br />
}}{{TableRowN| data_log_points | log_points | Array of Objects | The logable points<br />
}}{{TableRowN| log_points | category | String | The type of logable point<br />
}}{{TableRowN| log_points | (id_name) | Integer | The ID of the resource, e.g. "zone_id"<br />
}}{{TableRowN| log_points | log_point | Integer | The logable point ID<br />
}}{{TableEnd}}<br />
<br />
*Receive all data logable points for a device:<br />
*'''URI Mode:'''<br />
'''GET''' https://rest.sensaphone.net/api/v1/{ACCOUNT}/{SESSION}/history/data_log_points/resource_type/{device}/device_id/{1234}<br />
<br />
<br />
*'''JSON Mode:'''<br />
'''POST''' https://rest.sensaphone.net/api/v1/{ACCOUNT}/{SESSION}/history/data_log_points<br />
<br />
{<br />
"request_type": "read",<br />
"history":<br />
{<br />
"data_log_points": {<br />
"resource_type" : "device",<br />
"device_id" : 1234<br />
}<br />
}<br />
}<br />
<br />
==Event Log==<br />
<br />
<br />
'''Event Log Filter Options'''<br />
{{TableStart|border_size=1<br />
}}{{TableRowN| '''Property''' |'''Status''' | '''Type''' | '''Description'''<br />
}}{{TableRowN| contact_ids | Optional | Array of Integer | list of contact ids <br />
}}{{TableRowN| device_ids | Optional | Array of Integer | list of device ids <br />
}}{{TableRowN| zone_ids | Optional | Array of Integer | list of zone ids <br />
}}{{TableRowN| user_ids | Optional | Array of Integer | list of user ids<br />
}}{{TableRowN| event_types | Optional | Array of String | list of event types<br />
}}{{TableRowN| start | Optional | Integer | the start time (Sensaphone timestamp)<br />
}}{{TableRowN| end | Optional | Integer | the end time (Sensaphone timestamp)<br />
}}{{TableRowN| begin_offset | Optional | Integer | the beginning offset of the first record<br />
}}{{TableRowN| record_offset | Optional | Integer | the offset from the beginning<br />
}}{{TableEnd}}<br />
<br />
===GET===<br />
<br />
'''Event Log Request Properties'''<br />
{{TableStart|border_size=1<br />
}}{{TableRowN| '''Parent Property''' |'''Child Property'''| '''Type''' | '''Description'''<br />
}}{{TableRowN| &nbsp; | acctid | Integer | Account ID<br />
}}{{TableRowN| &nbsp; | session | String | Session ID<br />
}}{{TableRowN| &nbsp; | request_type | String | "read"<br />
}}{{TableRowN| &nbsp; | history | Object | The History object<br />
}}{{TableRowN| history | event_log | Object | Event Log Filter Options<br />
}}{{TableEnd}}<br />
<br />
'''Event Log Response Properties'''<br />
{{TableStart|border_size=1<br />
}}{{TableRowN| '''Parent Property''' |'''Child Property'''| '''Type''' | '''Description'''<br />
}}{{TableRowN| &nbsp; | history | Object | The history object<br />
}}{{TableRowN| history | event_log | Array of Objects | The returned log<br />
}}{{TableRowN| event_log | event | String | Which event<br />
}}{{TableRowN| event_log | when | String | When it changed<br />
}}{{TableRowN| event_log | epoch | Integer | The epoch time<br />
}}{{TableRowN| event_log | type | String | The type<br />
}}{{TableRowN| event_log | source | Object | The sources of the event<br />
}}{{TableRowN| source | <source_name> | String | A source<br />
}}{{TableRowN| history | event_log_filter | Object | Event Log Filter Options (Only returned in V2)<br />
}}{{TableEnd}}<br />
<br />
*Receive last 50 "Alarms Events" for a device:<br />
*'''URI Mode:'''<br />
'''GET''' https://rest.sensaphone.net/api/v1/{ACCOUNT}/{SESSION}/history/event_log/device_ids/{1234}/event_types/{alarm}/begin_offset/{0}/record_offset/{50}<br />
<br />
*'''JSON Mode:'''<br />
'''POST''' https://rest.sensaphone.net/api/v1/{ACCOUNT}/{SESSION}/history/event_log<br />
<br />
{<br />
"request_type": "read",<br />
"history":<br />
{<br />
"event_log": {<br />
"event_types" : ["alarm"],<br />
"device_ids" : [1234],<br />
"begin_offset" : 0,<br />
"record_offset" : 50<br />
}<br />
}<br />
}</div>
Derek
https://wiki.sensaphone.net/index.php?title=Sensaphone.net_API/history&diff=174
Sensaphone.net API/history
2017-10-25T14:52:18Z
<p>Derek: /* Data Log */</p>
<hr />
<div>=[[Sensaphone.net API]]=<br />
<br />
<br />
==Access==<br />
The History API allows access to the Audit Log, the Data Log, and the Event Log<br />
<br />
==Specifications==<br />
The URI Mode for the History API is unique because it allows filtering options to be specified in pairs and can be added in any order. Also, the array values are expressed as a common-separated list.<br />
/history/audit_log/var_ids/{1234,9876}/changes/{create}<br />
<br />
==Timestamps==<br />
The history APIs such as the Data Log use Sensaphone encoded timestamps. This allows the timestamps to be independent of the time zone of the client request, and return results adjusted to the time zone of the device, account, etc. Seconds, minutes, hours, days, and months are 0-indexed, in other words the range of month values is [0,11]. The year value is 2000-based and limited to 100 years.<br />
<br />
In order to create a Sensaphone timestamp given the year, month, day, hours, minutes, and seconds, convert each parameter to its equivalent value in seconds. For the example, in pseudo-code, a factory method would look as following:<br />
<br />
getSensaphoneTimestamp( year, month, day, hours, minutes, seconds ) {<br />
return ((seconds % 60)) +<br />
((minutes * 60) % 3600) +<br />
((hours * 3600) % 86400) +<br />
((day * 86400) % 2678400) + <br />
((month * 2678400) % 32140800) + <br />
((year % 100 * 32140800)); <br />
}<br />
<br />
==Audit Log==<br />
<br />
<br />
'''Audit Log Filter Options'''<br />
{{TableStart|border_size=1<br />
}}{{TableRowN| '''Property''' |'''Status''' | '''Type''' | '''Description'''<br />
}}{{TableRowN| var_ids | Optional | Array of Integer | list of variable ids <br />
}}{{TableRowN| user_ids | Optional | Array of Integer | list of user ids<br />
}}{{TableRowN| changes | Optional | Array of String | list of change types ("create","delete","update")<br />
}}{{TableRowN| start | Optional | Integer | the start time (Sensaphone timestamp)<br />
}}{{TableRowN| end | Optional | Integer | the end time (Sensaphone timestamp)<br />
}}{{TableRowN| begin_offset | Optional | Integer | the beginning offset of the first record<br />
}}{{TableRowN| record_offset | Optional | Integer | the offset from the beginning<br />
}}{{TableEnd}}<br />
<br />
===GET===<br />
<br />
'''Audit Log Request Properties'''<br />
{{TableStart|border_size=1<br />
}}{{TableRowN| '''Parent Property''' |'''Child Property'''| '''Type''' | '''Description'''<br />
}}{{TableRowN| &nbsp; | acctid | Integer | Account ID<br />
}}{{TableRowN| &nbsp; | session | String | Session ID<br />
}}{{TableRowN| &nbsp; | request_type | String | "read"<br />
}}{{TableRowN| &nbsp; | history | Object | The History object<br />
}}{{TableRowN| history | audit_log | Object | Audit Log Filter Options<br />
}}{{TableEnd}}<br />
<br />
'''Audit Log Response Properties'''<br />
{{TableStart|border_size=1<br />
}}{{TableRowN| '''Parent Property''' |'''Child Property'''| '''Type''' | '''Description'''<br />
}}{{TableRowN| &nbsp; | history | Object | The history object<br />
}}{{TableRowN| history | audit_log | Array of Objects | The returned log<br />
}}{{TableRowN| audit_log | change | String | The change that occurred<br />
}}{{TableRowN| audit_log | who | String | Who changed it<br />
}}{{TableRowN| audit_log | what | String | What changed<br />
}}{{TableRowN| audit_log | when | String | When it changed<br />
}}{{TableRowN| audit_log | epoch | Integer | The epoch time<br />
}}{{TableRowN| history | audit_log_filter | Object | Audit Log Filter Options (Only returned in V2)<br />
}}{{TableEnd}}<br />
<br />
*Receive all changes for a variable:<br />
*'''URI Mode:'''<br />
'''GET''' https://rest.sensaphone.net/api/v1/{ACCOUNT}/{SESSION}/history/audit_log/var_ids/{1234}<br />
<br />
*'''JSON Mode:'''<br />
'''POST''' https://rest.sensaphone.net/api/v1/{ACCOUNT}/{SESSION}/history/audit_log/<br />
<br />
{<br />
"request_type": "read",<br />
"history":<br />
{<br />
"audit_log": {<br />
"var_ids" : [1234]<br />
}<br />
}<br />
}<br />
<br />
==Data Log==<br />
<br />
<br />
'''Data Log Filter Options'''<br />
{{TableStart|border_size=1<br />
}}{{TableRowN| '''Property''' |'''Status''' | '''Type''' | '''Description'''<br />
}}{{TableRowN| log_points | Optional | Array of Integer | list of variable ids <br />
}}{{TableRowN| status | Optional | Array of String | list of AlarmStatus ("normal", "dependency", "alarm")<br />
}}{{TableRowN| start | Optional | Integer | the start time (Sensaphone timestamp)<br />
}}{{TableRowN| end | Optional | Integer | the end time (Sensaphone timestamp)<br />
}}{{TableRowN| begin_offset | Optional | Integer | the beginning offset of the first record<br />
}}{{TableRowN| record_offset | Optional | Integer | the offset from the beginning<br />
}}{{TableEnd}}<br />
<br />
===GET===<br />
<br />
'''Data Log Request Properties'''<br />
{{TableStart|border_size=1<br />
}}{{TableRowN| '''Parent Property''' |'''Child Property'''| '''Type''' | '''Description'''<br />
}}{{TableRowN| &nbsp; | acctid | Integer | Account ID<br />
}}{{TableRowN| &nbsp; | session | String | Session ID<br />
}}{{TableRowN| &nbsp; | request_type | String | "read"<br />
}}{{TableRowN| &nbsp; | history | Object | The History object<br />
}}{{TableRowN| history | data_log | Object | Data Log Filter Options<br />
}}{{TableEnd}}<br />
<br />
'''Data Log Response Properties'''<br />
{{TableStart|border_size=1<br />
}}{{TableRowN| '''Parent Property''' |'''Child Property'''| '''Type''' | '''Description'''<br />
}}{{TableRowN| &nbsp; | history | Object | The history object<br />
}}{{TableRowN| history | data_log | Array of Objects | The returned log<br />
}}{{TableRowN| data_log | record_id | String | The id of the record<br />
}}{{TableRowN| data_log | value | String | The value of the variable<br />
}}{{TableRowN| data_log | variable | String | The variable id<br />
}}{{TableRowN| data_log | is_alarm | String | Is an alarm<br />
}}{{TableRowN| data_log | epoch | Integer | The epoch time<br />
}}{{TableRowN| history | data_log_filter | Object | Audit Log Filter Options (Only returned in V2)<br />
}}{{TableEnd}}<br />
<br />
*Receive the last 50 logged datas for a log point<br />
*'''URI Mode:'''<br />
'''GET''' https://rest.sensaphone.net/api/v1/{ACCOUNT}/{SESSION}/history/data_log/log_points/{1234}/begin_offset/{0}/record_offset/{50}<br />
<br />
<br />
*'''JSON Mode:'''<br />
'''POST''' https://rest.sensaphone.net/api/v1/{ACCOUNT}/{SESSION}/history/data_log<br />
<br />
{<br />
"request_type": "read",<br />
"history":<br />
{<br />
"data_log": {<br />
"log_points" : [1234],<br />
"begin_offset" : 0,<br />
"record_offset" : 50<br />
}<br />
}<br />
}<br />
<br />
==Data Log Points==<br />
Poll the Data Log Points to get the possible logable points to use for the Data Log<br />
<br />
===GET===<br />
<br />
'''Data Log Points Request Properties'''<br />
{{TableStart|border_size=1<br />
}}{{TableRowN| '''Parent Property''' |'''Child Property'''| '''Type''' | '''Description'''<br />
}}{{TableRowN| &nbsp; | acctid | Integer | Account ID<br />
}}{{TableRowN| &nbsp; | session | String | Session ID<br />
}}{{TableRowN| &nbsp; | request_type | String | "read"<br />
}}{{TableRowN| &nbsp; | history | Object | The History object<br />
}}{{TableRowN| history | data_log_points | Object | <br />
}}{{TableRowN| data_log_points | resource_type | String | the name of the resource, e.g. "device"<br />
}}{{TableRowN| data_log_points | (id_name) | Integer | The ID of the resource, e.g. "device_id"<br />
}}{{TableEnd}}<br />
<br />
'''Data Log Points Response Properties'''<br />
{{TableStart|border_size=1<br />
}}{{TableRowN| '''Parent Property''' |'''Child Property'''| '''Type''' | '''Description'''<br />
}}{{TableRowN| &nbsp; | history | Object | The history object<br />
}}{{TableRowN| history | data_log_points | Object | The returned log<br />
}}{{TableRowN| data_log_points | resource_type | String | the name of the resource, e.g. "device"<br />
}}{{TableRowN| data_log_points | (id_name) | Integer | The ID of the resource, e.g. "device_id"<br />
}}{{TableRowN| data_log_points | log_points | Array of Objects | The logable points<br />
}}{{TableRowN| log_points | category | String | The type of logable point<br />
}}{{TableRowN| log_points | (id_name) | Integer | The ID of the resource, e.g. "zone_id"<br />
}}{{TableRowN| log_points | log_point | Integer | The logable point ID<br />
}}{{TableEnd}}<br />
<br />
*Receive all data logable points for a device:<br />
*'''URI Mode:'''<br />
'''GET''' https://rest.sensaphone.net/api/v1/{ACCOUNT}/{SESSION}/history/data_log_points/resource_type/{device}/device_id/{1234}<br />
<br />
<br />
*'''JSON Mode:'''<br />
'''POST''' https://rest.sensaphone.net/api/v1/{ACCOUNT}/{SESSION}/history/data_log_points<br />
<br />
{<br />
"request_type": "read",<br />
"history":<br />
{<br />
"data_log_points": {<br />
"resource_type" : "device",<br />
"device_id" : 1234<br />
}<br />
}<br />
}<br />
<br />
==Event Log==<br />
<br />
<br />
'''Event Log Filter Options'''<br />
{{TableStart|border_size=1<br />
}}{{TableRowN| '''Property''' |'''Status''' | '''Type''' | '''Description'''<br />
}}{{TableRowN| contact_ids | Optional | Array of Integer | list of contact ids <br />
}}{{TableRowN| device_ids | Optional | Array of Integer | list of device ids <br />
}}{{TableRowN| zone_ids | Optional | Array of Integer | list of zone ids <br />
}}{{TableRowN| user_ids | Optional | Array of Integer | list of user ids<br />
}}{{TableRowN| event_types | Optional | Array of String | list of event types<br />
}}{{TableRowN| start | Optional | Integer | the start time (unix time)<br />
}}{{TableRowN| end | Optional | Integer | the end time (unix time)<br />
}}{{TableRowN| begin_offset | Optional | Integer | the beginning offset of the first record<br />
}}{{TableRowN| record_offset | Optional | Integer | the offset from the beginning<br />
}}{{TableEnd}}<br />
<br />
===GET===<br />
<br />
'''Event Log Request Properties'''<br />
{{TableStart|border_size=1<br />
}}{{TableRowN| '''Parent Property''' |'''Child Property'''| '''Type''' | '''Description'''<br />
}}{{TableRowN| &nbsp; | acctid | Integer | Account ID<br />
}}{{TableRowN| &nbsp; | session | String | Session ID<br />
}}{{TableRowN| &nbsp; | request_type | String | "read"<br />
}}{{TableRowN| &nbsp; | history | Object | The History object<br />
}}{{TableRowN| history | event_log | Object | Event Log Filter Options<br />
}}{{TableEnd}}<br />
<br />
'''Event Log Response Properties'''<br />
{{TableStart|border_size=1<br />
}}{{TableRowN| '''Parent Property''' |'''Child Property'''| '''Type''' | '''Description'''<br />
}}{{TableRowN| &nbsp; | history | Object | The history object<br />
}}{{TableRowN| history | event_log | Array of Objects | The returned log<br />
}}{{TableRowN| event_log | event | String | Which event<br />
}}{{TableRowN| event_log | when | String | When it changed<br />
}}{{TableRowN| event_log | epoch | Integer | The epoch time<br />
}}{{TableRowN| event_log | type | String | The type<br />
}}{{TableRowN| event_log | source | Object | The sources of the event<br />
}}{{TableRowN| source | <source_name> | String | A source<br />
}}{{TableRowN| history | event_log_filter | Object | Event Log Filter Options (Only returned in V2)<br />
}}{{TableEnd}}<br />
<br />
*Receive last 50 "Alarms Events" for a device:<br />
*'''URI Mode:'''<br />
'''GET''' https://rest.sensaphone.net/api/v1/{ACCOUNT}/{SESSION}/history/event_log/device_ids/{1234}/event_types/{alarm}/begin_offset/{0}/record_offset/{50}<br />
<br />
*'''JSON Mode:'''<br />
'''POST''' https://rest.sensaphone.net/api/v1/{ACCOUNT}/{SESSION}/history/event_log<br />
<br />
{<br />
"request_type": "read",<br />
"history":<br />
{<br />
"event_log": {<br />
"event_types" : ["alarm"],<br />
"device_ids" : [1234],<br />
"begin_offset" : 0,<br />
"record_offset" : 50<br />
}<br />
}<br />
}</div>
Derek
https://wiki.sensaphone.net/index.php?title=Sensaphone.net_API/history&diff=173
Sensaphone.net API/history
2017-10-25T14:51:56Z
<p>Derek: /* Audit Log */</p>
<hr />
<div>=[[Sensaphone.net API]]=<br />
<br />
<br />
==Access==<br />
The History API allows access to the Audit Log, the Data Log, and the Event Log<br />
<br />
==Specifications==<br />
The URI Mode for the History API is unique because it allows filtering options to be specified in pairs and can be added in any order. Also, the array values are expressed as a common-separated list.<br />
/history/audit_log/var_ids/{1234,9876}/changes/{create}<br />
<br />
==Timestamps==<br />
The history APIs such as the Data Log use Sensaphone encoded timestamps. This allows the timestamps to be independent of the time zone of the client request, and return results adjusted to the time zone of the device, account, etc. Seconds, minutes, hours, days, and months are 0-indexed, in other words the range of month values is [0,11]. The year value is 2000-based and limited to 100 years.<br />
<br />
In order to create a Sensaphone timestamp given the year, month, day, hours, minutes, and seconds, convert each parameter to its equivalent value in seconds. For the example, in pseudo-code, a factory method would look as following:<br />
<br />
getSensaphoneTimestamp( year, month, day, hours, minutes, seconds ) {<br />
return ((seconds % 60)) +<br />
((minutes * 60) % 3600) +<br />
((hours * 3600) % 86400) +<br />
((day * 86400) % 2678400) + <br />
((month * 2678400) % 32140800) + <br />
((year % 100 * 32140800)); <br />
}<br />
<br />
==Audit Log==<br />
<br />
<br />
'''Audit Log Filter Options'''<br />
{{TableStart|border_size=1<br />
}}{{TableRowN| '''Property''' |'''Status''' | '''Type''' | '''Description'''<br />
}}{{TableRowN| var_ids | Optional | Array of Integer | list of variable ids <br />
}}{{TableRowN| user_ids | Optional | Array of Integer | list of user ids<br />
}}{{TableRowN| changes | Optional | Array of String | list of change types ("create","delete","update")<br />
}}{{TableRowN| start | Optional | Integer | the start time (Sensaphone timestamp)<br />
}}{{TableRowN| end | Optional | Integer | the end time (Sensaphone timestamp)<br />
}}{{TableRowN| begin_offset | Optional | Integer | the beginning offset of the first record<br />
}}{{TableRowN| record_offset | Optional | Integer | the offset from the beginning<br />
}}{{TableEnd}}<br />
<br />
===GET===<br />
<br />
'''Audit Log Request Properties'''<br />
{{TableStart|border_size=1<br />
}}{{TableRowN| '''Parent Property''' |'''Child Property'''| '''Type''' | '''Description'''<br />
}}{{TableRowN| &nbsp; | acctid | Integer | Account ID<br />
}}{{TableRowN| &nbsp; | session | String | Session ID<br />
}}{{TableRowN| &nbsp; | request_type | String | "read"<br />
}}{{TableRowN| &nbsp; | history | Object | The History object<br />
}}{{TableRowN| history | audit_log | Object | Audit Log Filter Options<br />
}}{{TableEnd}}<br />
<br />
'''Audit Log Response Properties'''<br />
{{TableStart|border_size=1<br />
}}{{TableRowN| '''Parent Property''' |'''Child Property'''| '''Type''' | '''Description'''<br />
}}{{TableRowN| &nbsp; | history | Object | The history object<br />
}}{{TableRowN| history | audit_log | Array of Objects | The returned log<br />
}}{{TableRowN| audit_log | change | String | The change that occurred<br />
}}{{TableRowN| audit_log | who | String | Who changed it<br />
}}{{TableRowN| audit_log | what | String | What changed<br />
}}{{TableRowN| audit_log | when | String | When it changed<br />
}}{{TableRowN| audit_log | epoch | Integer | The epoch time<br />
}}{{TableRowN| history | audit_log_filter | Object | Audit Log Filter Options (Only returned in V2)<br />
}}{{TableEnd}}<br />
<br />
*Receive all changes for a variable:<br />
*'''URI Mode:'''<br />
'''GET''' https://rest.sensaphone.net/api/v1/{ACCOUNT}/{SESSION}/history/audit_log/var_ids/{1234}<br />
<br />
*'''JSON Mode:'''<br />
'''POST''' https://rest.sensaphone.net/api/v1/{ACCOUNT}/{SESSION}/history/audit_log/<br />
<br />
{<br />
"request_type": "read",<br />
"history":<br />
{<br />
"audit_log": {<br />
"var_ids" : [1234]<br />
}<br />
}<br />
}<br />
<br />
==Data Log==<br />
<br />
<br />
'''Data Log Filter Options'''<br />
{{TableStart|border_size=1<br />
}}{{TableRowN| '''Property''' |'''Status''' | '''Type''' | '''Description'''<br />
}}{{TableRowN| log_points | Optional | Array of Integer | list of variable ids <br />
}}{{TableRowN| status | Optional | Array of String | list of AlarmStatus ("normal", "dependency", "alarm")<br />
}}{{TableRowN| start | Optional | Integer | the start time (unix time)<br />
}}{{TableRowN| end | Optional | Integer | the end time (unix time)<br />
}}{{TableRowN| begin_offset | Optional | Integer | the beginning offset of the first record<br />
}}{{TableRowN| record_offset | Optional | Integer | the offset from the beginning<br />
}}{{TableEnd}}<br />
<br />
===GET===<br />
<br />
'''Data Log Request Properties'''<br />
{{TableStart|border_size=1<br />
}}{{TableRowN| '''Parent Property''' |'''Child Property'''| '''Type''' | '''Description'''<br />
}}{{TableRowN| &nbsp; | acctid | Integer | Account ID<br />
}}{{TableRowN| &nbsp; | session | String | Session ID<br />
}}{{TableRowN| &nbsp; | request_type | String | "read"<br />
}}{{TableRowN| &nbsp; | history | Object | The History object<br />
}}{{TableRowN| history | data_log | Object | Data Log Filter Options<br />
}}{{TableEnd}}<br />
<br />
'''Data Log Response Properties'''<br />
{{TableStart|border_size=1<br />
}}{{TableRowN| '''Parent Property''' |'''Child Property'''| '''Type''' | '''Description'''<br />
}}{{TableRowN| &nbsp; | history | Object | The history object<br />
}}{{TableRowN| history | data_log | Array of Objects | The returned log<br />
}}{{TableRowN| data_log | record_id | String | The id of the record<br />
}}{{TableRowN| data_log | value | String | The value of the variable<br />
}}{{TableRowN| data_log | variable | String | The variable id<br />
}}{{TableRowN| data_log | is_alarm | String | Is an alarm<br />
}}{{TableRowN| data_log | epoch | Integer | The epoch time<br />
}}{{TableRowN| history | data_log_filter | Object | Audit Log Filter Options (Only returned in V2)<br />
}}{{TableEnd}}<br />
<br />
*Receive the last 50 logged datas for a log point<br />
*'''URI Mode:'''<br />
'''GET''' https://rest.sensaphone.net/api/v1/{ACCOUNT}/{SESSION}/history/data_log/log_points/{1234}/begin_offset/{0}/record_offset/{50}<br />
<br />
<br />
*'''JSON Mode:'''<br />
'''POST''' https://rest.sensaphone.net/api/v1/{ACCOUNT}/{SESSION}/history/data_log<br />
<br />
{<br />
"request_type": "read",<br />
"history":<br />
{<br />
"data_log": {<br />
"log_points" : [1234],<br />
"begin_offset" : 0,<br />
"record_offset" : 50<br />
}<br />
}<br />
}<br />
==Data Log Points==<br />
Poll the Data Log Points to get the possible logable points to use for the Data Log<br />
<br />
===GET===<br />
<br />
'''Data Log Points Request Properties'''<br />
{{TableStart|border_size=1<br />
}}{{TableRowN| '''Parent Property''' |'''Child Property'''| '''Type''' | '''Description'''<br />
}}{{TableRowN| &nbsp; | acctid | Integer | Account ID<br />
}}{{TableRowN| &nbsp; | session | String | Session ID<br />
}}{{TableRowN| &nbsp; | request_type | String | "read"<br />
}}{{TableRowN| &nbsp; | history | Object | The History object<br />
}}{{TableRowN| history | data_log_points | Object | <br />
}}{{TableRowN| data_log_points | resource_type | String | the name of the resource, e.g. "device"<br />
}}{{TableRowN| data_log_points | (id_name) | Integer | The ID of the resource, e.g. "device_id"<br />
}}{{TableEnd}}<br />
<br />
'''Data Log Points Response Properties'''<br />
{{TableStart|border_size=1<br />
}}{{TableRowN| '''Parent Property''' |'''Child Property'''| '''Type''' | '''Description'''<br />
}}{{TableRowN| &nbsp; | history | Object | The history object<br />
}}{{TableRowN| history | data_log_points | Object | The returned log<br />
}}{{TableRowN| data_log_points | resource_type | String | the name of the resource, e.g. "device"<br />
}}{{TableRowN| data_log_points | (id_name) | Integer | The ID of the resource, e.g. "device_id"<br />
}}{{TableRowN| data_log_points | log_points | Array of Objects | The logable points<br />
}}{{TableRowN| log_points | category | String | The type of logable point<br />
}}{{TableRowN| log_points | (id_name) | Integer | The ID of the resource, e.g. "zone_id"<br />
}}{{TableRowN| log_points | log_point | Integer | The logable point ID<br />
}}{{TableEnd}}<br />
<br />
*Receive all data logable points for a device:<br />
*'''URI Mode:'''<br />
'''GET''' https://rest.sensaphone.net/api/v1/{ACCOUNT}/{SESSION}/history/data_log_points/resource_type/{device}/device_id/{1234}<br />
<br />
<br />
*'''JSON Mode:'''<br />
'''POST''' https://rest.sensaphone.net/api/v1/{ACCOUNT}/{SESSION}/history/data_log_points<br />
<br />
{<br />
"request_type": "read",<br />
"history":<br />
{<br />
"data_log_points": {<br />
"resource_type" : "device",<br />
"device_id" : 1234<br />
}<br />
}<br />
}<br />
<br />
==Event Log==<br />
<br />
<br />
'''Event Log Filter Options'''<br />
{{TableStart|border_size=1<br />
}}{{TableRowN| '''Property''' |'''Status''' | '''Type''' | '''Description'''<br />
}}{{TableRowN| contact_ids | Optional | Array of Integer | list of contact ids <br />
}}{{TableRowN| device_ids | Optional | Array of Integer | list of device ids <br />
}}{{TableRowN| zone_ids | Optional | Array of Integer | list of zone ids <br />
}}{{TableRowN| user_ids | Optional | Array of Integer | list of user ids<br />
}}{{TableRowN| event_types | Optional | Array of String | list of event types<br />
}}{{TableRowN| start | Optional | Integer | the start time (unix time)<br />
}}{{TableRowN| end | Optional | Integer | the end time (unix time)<br />
}}{{TableRowN| begin_offset | Optional | Integer | the beginning offset of the first record<br />
}}{{TableRowN| record_offset | Optional | Integer | the offset from the beginning<br />
}}{{TableEnd}}<br />
<br />
===GET===<br />
<br />
'''Event Log Request Properties'''<br />
{{TableStart|border_size=1<br />
}}{{TableRowN| '''Parent Property''' |'''Child Property'''| '''Type''' | '''Description'''<br />
}}{{TableRowN| &nbsp; | acctid | Integer | Account ID<br />
}}{{TableRowN| &nbsp; | session | String | Session ID<br />
}}{{TableRowN| &nbsp; | request_type | String | "read"<br />
}}{{TableRowN| &nbsp; | history | Object | The History object<br />
}}{{TableRowN| history | event_log | Object | Event Log Filter Options<br />
}}{{TableEnd}}<br />
<br />
'''Event Log Response Properties'''<br />
{{TableStart|border_size=1<br />
}}{{TableRowN| '''Parent Property''' |'''Child Property'''| '''Type''' | '''Description'''<br />
}}{{TableRowN| &nbsp; | history | Object | The history object<br />
}}{{TableRowN| history | event_log | Array of Objects | The returned log<br />
}}{{TableRowN| event_log | event | String | Which event<br />
}}{{TableRowN| event_log | when | String | When it changed<br />
}}{{TableRowN| event_log | epoch | Integer | The epoch time<br />
}}{{TableRowN| event_log | type | String | The type<br />
}}{{TableRowN| event_log | source | Object | The sources of the event<br />
}}{{TableRowN| source | <source_name> | String | A source<br />
}}{{TableRowN| history | event_log_filter | Object | Event Log Filter Options (Only returned in V2)<br />
}}{{TableEnd}}<br />
<br />
*Receive last 50 "Alarms Events" for a device:<br />
*'''URI Mode:'''<br />
'''GET''' https://rest.sensaphone.net/api/v1/{ACCOUNT}/{SESSION}/history/event_log/device_ids/{1234}/event_types/{alarm}/begin_offset/{0}/record_offset/{50}<br />
<br />
*'''JSON Mode:'''<br />
'''POST''' https://rest.sensaphone.net/api/v1/{ACCOUNT}/{SESSION}/history/event_log<br />
<br />
{<br />
"request_type": "read",<br />
"history":<br />
{<br />
"event_log": {<br />
"event_types" : ["alarm"],<br />
"device_ids" : [1234],<br />
"begin_offset" : 0,<br />
"record_offset" : 50<br />
}<br />
}<br />
}</div>
Derek
https://wiki.sensaphone.net/index.php?title=Sensaphone.net_API/history&diff=172
Sensaphone.net API/history
2017-10-25T14:32:45Z
<p>Derek: /* Timestamps */</p>
<hr />
<div>=[[Sensaphone.net API]]=<br />
<br />
<br />
==Access==<br />
The History API allows access to the Audit Log, the Data Log, and the Event Log<br />
<br />
==Specifications==<br />
The URI Mode for the History API is unique because it allows filtering options to be specified in pairs and can be added in any order. Also, the array values are expressed as a common-separated list.<br />
/history/audit_log/var_ids/{1234,9876}/changes/{create}<br />
<br />
==Timestamps==<br />
The history APIs such as the Data Log use Sensaphone encoded timestamps. This allows the timestamps to be independent of the time zone of the client request, and return results adjusted to the time zone of the device, account, etc. Seconds, minutes, hours, days, and months are 0-indexed, in other words the range of month values is [0,11]. The year value is 2000-based and limited to 100 years.<br />
<br />
In order to create a Sensaphone timestamp given the year, month, day, hours, minutes, and seconds, convert each parameter to its equivalent value in seconds. For the example, in pseudo-code, a factory method would look as following:<br />
<br />
getSensaphoneTimestamp( year, month, day, hours, minutes, seconds ) {<br />
return ((seconds % 60)) +<br />
((minutes * 60) % 3600) +<br />
((hours * 3600) % 86400) +<br />
((day * 86400) % 2678400) + <br />
((month * 2678400) % 32140800) + <br />
((year % 100 * 32140800)); <br />
}<br />
<br />
==Audit Log==<br />
<br />
<br />
'''Audit Log Filter Options'''<br />
{{TableStart|border_size=1<br />
}}{{TableRowN| '''Property''' |'''Status''' | '''Type''' | '''Description'''<br />
}}{{TableRowN| var_ids | Optional | Array of Integer | list of variable ids <br />
}}{{TableRowN| user_ids | Optional | Array of Integer | list of user ids<br />
}}{{TableRowN| changes | Optional | Array of String | list of change types ("create","delete","update")<br />
}}{{TableRowN| start | Optional | Integer | the start time (unix time)<br />
}}{{TableRowN| end | Optional | Integer | the end time (unix time)<br />
}}{{TableRowN| begin_offset | Optional | Integer | the beginning offset of the first record<br />
}}{{TableRowN| record_offset | Optional | Integer | the offset from the beginning<br />
}}{{TableEnd}}<br />
<br />
===GET===<br />
<br />
'''Audit Log Request Properties'''<br />
{{TableStart|border_size=1<br />
}}{{TableRowN| '''Parent Property''' |'''Child Property'''| '''Type''' | '''Description'''<br />
}}{{TableRowN| &nbsp; | acctid | Integer | Account ID<br />
}}{{TableRowN| &nbsp; | session | String | Session ID<br />
}}{{TableRowN| &nbsp; | request_type | String | "read"<br />
}}{{TableRowN| &nbsp; | history | Object | The History object<br />
}}{{TableRowN| history | audit_log | Object | Audit Log Filter Options<br />
}}{{TableEnd}}<br />
<br />
'''Audit Log Response Properties'''<br />
{{TableStart|border_size=1<br />
}}{{TableRowN| '''Parent Property''' |'''Child Property'''| '''Type''' | '''Description'''<br />
}}{{TableRowN| &nbsp; | history | Object | The history object<br />
}}{{TableRowN| history | audit_log | Array of Objects | The returned log<br />
}}{{TableRowN| audit_log | change | String | The change that occurred<br />
}}{{TableRowN| audit_log | who | String | Who changed it<br />
}}{{TableRowN| audit_log | what | String | What changed<br />
}}{{TableRowN| audit_log | when | String | When it changed<br />
}}{{TableRowN| audit_log | epoch | Integer | The epoch time<br />
}}{{TableRowN| history | audit_log_filter | Object | Audit Log Filter Options (Only returned in V2)<br />
}}{{TableEnd}}<br />
<br />
*Receive all changes for a variable:<br />
*'''URI Mode:'''<br />
'''GET''' https://rest.sensaphone.net/api/v1/{ACCOUNT}/{SESSION}/history/audit_log/var_ids/{1234}<br />
<br />
*'''JSON Mode:'''<br />
'''POST''' https://rest.sensaphone.net/api/v1/{ACCOUNT}/{SESSION}/history/audit_log/<br />
<br />
{<br />
"request_type": "read",<br />
"history":<br />
{<br />
"audit_log": {<br />
"var_ids" : [1234]<br />
}<br />
}<br />
}<br />
<br />
==Data Log==<br />
<br />
<br />
'''Data Log Filter Options'''<br />
{{TableStart|border_size=1<br />
}}{{TableRowN| '''Property''' |'''Status''' | '''Type''' | '''Description'''<br />
}}{{TableRowN| log_points | Optional | Array of Integer | list of variable ids <br />
}}{{TableRowN| status | Optional | Array of String | list of AlarmStatus ("normal", "dependency", "alarm")<br />
}}{{TableRowN| start | Optional | Integer | the start time (unix time)<br />
}}{{TableRowN| end | Optional | Integer | the end time (unix time)<br />
}}{{TableRowN| begin_offset | Optional | Integer | the beginning offset of the first record<br />
}}{{TableRowN| record_offset | Optional | Integer | the offset from the beginning<br />
}}{{TableEnd}}<br />
<br />
===GET===<br />
<br />
'''Data Log Request Properties'''<br />
{{TableStart|border_size=1<br />
}}{{TableRowN| '''Parent Property''' |'''Child Property'''| '''Type''' | '''Description'''<br />
}}{{TableRowN| &nbsp; | acctid | Integer | Account ID<br />
}}{{TableRowN| &nbsp; | session | String | Session ID<br />
}}{{TableRowN| &nbsp; | request_type | String | "read"<br />
}}{{TableRowN| &nbsp; | history | Object | The History object<br />
}}{{TableRowN| history | data_log | Object | Data Log Filter Options<br />
}}{{TableEnd}}<br />
<br />
'''Data Log Response Properties'''<br />
{{TableStart|border_size=1<br />
}}{{TableRowN| '''Parent Property''' |'''Child Property'''| '''Type''' | '''Description'''<br />
}}{{TableRowN| &nbsp; | history | Object | The history object<br />
}}{{TableRowN| history | data_log | Array of Objects | The returned log<br />
}}{{TableRowN| data_log | record_id | String | The id of the record<br />
}}{{TableRowN| data_log | value | String | The value of the variable<br />
}}{{TableRowN| data_log | variable | String | The variable id<br />
}}{{TableRowN| data_log | is_alarm | String | Is an alarm<br />
}}{{TableRowN| data_log | epoch | Integer | The epoch time<br />
}}{{TableRowN| history | data_log_filter | Object | Audit Log Filter Options (Only returned in V2)<br />
}}{{TableEnd}}<br />
<br />
*Receive the last 50 logged datas for a log point<br />
*'''URI Mode:'''<br />
'''GET''' https://rest.sensaphone.net/api/v1/{ACCOUNT}/{SESSION}/history/data_log/log_points/{1234}/begin_offset/{0}/record_offset/{50}<br />
<br />
<br />
*'''JSON Mode:'''<br />
'''POST''' https://rest.sensaphone.net/api/v1/{ACCOUNT}/{SESSION}/history/data_log<br />
<br />
{<br />
"request_type": "read",<br />
"history":<br />
{<br />
"data_log": {<br />
"log_points" : [1234],<br />
"begin_offset" : 0,<br />
"record_offset" : 50<br />
}<br />
}<br />
}<br />
==Data Log Points==<br />
Poll the Data Log Points to get the possible logable points to use for the Data Log<br />
<br />
===GET===<br />
<br />
'''Data Log Points Request Properties'''<br />
{{TableStart|border_size=1<br />
}}{{TableRowN| '''Parent Property''' |'''Child Property'''| '''Type''' | '''Description'''<br />
}}{{TableRowN| &nbsp; | acctid | Integer | Account ID<br />
}}{{TableRowN| &nbsp; | session | String | Session ID<br />
}}{{TableRowN| &nbsp; | request_type | String | "read"<br />
}}{{TableRowN| &nbsp; | history | Object | The History object<br />
}}{{TableRowN| history | data_log_points | Object | <br />
}}{{TableRowN| data_log_points | resource_type | String | the name of the resource, e.g. "device"<br />
}}{{TableRowN| data_log_points | (id_name) | Integer | The ID of the resource, e.g. "device_id"<br />
}}{{TableEnd}}<br />
<br />
'''Data Log Points Response Properties'''<br />
{{TableStart|border_size=1<br />
}}{{TableRowN| '''Parent Property''' |'''Child Property'''| '''Type''' | '''Description'''<br />
}}{{TableRowN| &nbsp; | history | Object | The history object<br />
}}{{TableRowN| history | data_log_points | Object | The returned log<br />
}}{{TableRowN| data_log_points | resource_type | String | the name of the resource, e.g. "device"<br />
}}{{TableRowN| data_log_points | (id_name) | Integer | The ID of the resource, e.g. "device_id"<br />
}}{{TableRowN| data_log_points | log_points | Array of Objects | The logable points<br />
}}{{TableRowN| log_points | category | String | The type of logable point<br />
}}{{TableRowN| log_points | (id_name) | Integer | The ID of the resource, e.g. "zone_id"<br />
}}{{TableRowN| log_points | log_point | Integer | The logable point ID<br />
}}{{TableEnd}}<br />
<br />
*Receive all data logable points for a device:<br />
*'''URI Mode:'''<br />
'''GET''' https://rest.sensaphone.net/api/v1/{ACCOUNT}/{SESSION}/history/data_log_points/resource_type/{device}/device_id/{1234}<br />
<br />
<br />
*'''JSON Mode:'''<br />
'''POST''' https://rest.sensaphone.net/api/v1/{ACCOUNT}/{SESSION}/history/data_log_points<br />
<br />
{<br />
"request_type": "read",<br />
"history":<br />
{<br />
"data_log_points": {<br />
"resource_type" : "device",<br />
"device_id" : 1234<br />
}<br />
}<br />
}<br />
<br />
==Event Log==<br />
<br />
<br />
'''Event Log Filter Options'''<br />
{{TableStart|border_size=1<br />
}}{{TableRowN| '''Property''' |'''Status''' | '''Type''' | '''Description'''<br />
}}{{TableRowN| contact_ids | Optional | Array of Integer | list of contact ids <br />
}}{{TableRowN| device_ids | Optional | Array of Integer | list of device ids <br />
}}{{TableRowN| zone_ids | Optional | Array of Integer | list of zone ids <br />
}}{{TableRowN| user_ids | Optional | Array of Integer | list of user ids<br />
}}{{TableRowN| event_types | Optional | Array of String | list of event types<br />
}}{{TableRowN| start | Optional | Integer | the start time (unix time)<br />
}}{{TableRowN| end | Optional | Integer | the end time (unix time)<br />
}}{{TableRowN| begin_offset | Optional | Integer | the beginning offset of the first record<br />
}}{{TableRowN| record_offset | Optional | Integer | the offset from the beginning<br />
}}{{TableEnd}}<br />
<br />
===GET===<br />
<br />
'''Event Log Request Properties'''<br />
{{TableStart|border_size=1<br />
}}{{TableRowN| '''Parent Property''' |'''Child Property'''| '''Type''' | '''Description'''<br />
}}{{TableRowN| &nbsp; | acctid | Integer | Account ID<br />
}}{{TableRowN| &nbsp; | session | String | Session ID<br />
}}{{TableRowN| &nbsp; | request_type | String | "read"<br />
}}{{TableRowN| &nbsp; | history | Object | The History object<br />
}}{{TableRowN| history | event_log | Object | Event Log Filter Options<br />
}}{{TableEnd}}<br />
<br />
'''Event Log Response Properties'''<br />
{{TableStart|border_size=1<br />
}}{{TableRowN| '''Parent Property''' |'''Child Property'''| '''Type''' | '''Description'''<br />
}}{{TableRowN| &nbsp; | history | Object | The history object<br />
}}{{TableRowN| history | event_log | Array of Objects | The returned log<br />
}}{{TableRowN| event_log | event | String | Which event<br />
}}{{TableRowN| event_log | when | String | When it changed<br />
}}{{TableRowN| event_log | epoch | Integer | The epoch time<br />
}}{{TableRowN| event_log | type | String | The type<br />
}}{{TableRowN| event_log | source | Object | The sources of the event<br />
}}{{TableRowN| source | <source_name> | String | A source<br />
}}{{TableRowN| history | event_log_filter | Object | Event Log Filter Options (Only returned in V2)<br />
}}{{TableEnd}}<br />
<br />
*Receive last 50 "Alarms Events" for a device:<br />
*'''URI Mode:'''<br />
'''GET''' https://rest.sensaphone.net/api/v1/{ACCOUNT}/{SESSION}/history/event_log/device_ids/{1234}/event_types/{alarm}/begin_offset/{0}/record_offset/{50}<br />
<br />
*'''JSON Mode:'''<br />
'''POST''' https://rest.sensaphone.net/api/v1/{ACCOUNT}/{SESSION}/history/event_log<br />
<br />
{<br />
"request_type": "read",<br />
"history":<br />
{<br />
"event_log": {<br />
"event_types" : ["alarm"],<br />
"device_ids" : [1234],<br />
"begin_offset" : 0,<br />
"record_offset" : 50<br />
}<br />
}<br />
}</div>
Derek
https://wiki.sensaphone.net/index.php?title=Sensaphone.net_API/login&diff=171
Sensaphone.net API/login
2017-10-10T19:11:26Z
<p>Derek: /* DELETE */</p>
<hr />
<div>=[[Sensaphone.net API]]=<br />
<br />
The Login API will be used to log in to the Sensaphone.net system. When a user logs in with their username and password they will be assigned a session UUID. The session UUID will have a corresponding time stamp and a timed expiration for their session. The session UUID and statically assigned Account ID will be used as the primary identifier instead of including a username and password in subsequent URI requests. <br />
<br />
==Example Call==<br />
https://sensaphone.net/api/v1/login/{USERNAME}/{PASSWORD}<br />
<br />
==Values==<br />
*Username<br />
*Password<br />
*Session UUID<br />
*Session Time stamp<br />
*Session Expiration<br />
<br />
==Example Requests==<br />
===GET===<br />
'''URI Mode Request URI's:'''<br />
*Receive Login information <br />
'''GET''' https://rest.sensaphone.net/api/v1/{ACCTID}/{SESSION}/login<br />
*Receive a Login timestamp for a session <br />
'''GET''' https://rest.sensaphone.net/api/v1/{ACCTID}/{SESSION}/login/login_timestamp<br />
*Receive the number of seconds until a session expires <br />
'''GET''' https://rest.sensaphone.net/api/v1/{ACCTID}/{SESSION}/login/session_expiration <br />
<br />
'''JSON MODE Request URI:'''<br />
*Receive Login information <br />
'''POST''' https://rest.sensaphone.net/api/v1/login<br />
<br />
{{TableStart|border_size=1<br />
}}{{TableRowN| '''Request Property''' | '''Status''' | '''Type''' | '''Description'''<br />
}}{{TableRowN| acctid | Required | Integer | Static ID of user<br />
}}{{TableRowN| session | Required | Integer | Session ID of user<br />
}}{{TableEnd}}<br />
<br><br />
{{TableStart|border_size=1<br />
}}{{TableRowN| '''Response Property''' | '''Included''' | '''Type''' | '''Description'''<br />
}}{{TableRowN| login_timestamp | Optional | String | Time stamp of last log in<br />
}}{{TableRowN| session_expiration | Optional | Integer | Seconds until log in expiration<br />
}}{{TableRowN| user_id | Optional | Integer | ID of the logged in user<br />
}}{{TableEnd}}<br />
<br />
====Example JSON====<br />
Log in with a username and password using JSON mode.<br />
*'''Request JSON:'''<br />
{<br />
"request_type":"create",<br />
"resource": "login",<br />
"user_name": "myusername",<br />
"password": "pass123"<br />
}<br />
<br />
*'''Response JSON:'''<br />
{<br />
"result": {<br />
"success": true,<br />
"code": 0,<br />
"message": "Success"<br />
},<br />
"response": {<br />
"acctid": 987654,<br />
"session": "0123-4567-8901",<br />
"login_timestamp": 1499459402,<br />
"session_expiration": 86400,<br />
"user_id": 00000001<br />
}<br />
}<br />
<br />
Receive Login information for a given session UUID.<br />
<br />
*'''Request JSON:'''<br />
{<br />
"request_type:"read",<br />
"resource":"login",<br />
"acctid":987654,<br />
"session":"0123-4567-8901",<br />
"login":null<br />
}<br />
<br />
*'''Response JSON:'''<br />
{<br />
"result":<br />
{<br />
"success: true,<br />
"code": 0,<br />
"message":"OK",<br />
},<br />
"response":<br />
{<br />
"login_timestamp":"2014-12-31 23:59:59",<br />
"session_expiration":60<br />
}<br />
}<br />
<br />
===PUT===<br />
PUT will be used only to update a Login session.<br />
<br />
'''URI Mode Request URI:'''<br />
*Request to update a Login session <br />
'''PUT''' https://rest.sensaphone.net/api/v1/{ACCTID}/{SESSION}/login<br />
'''JSON Mode Request URI:'''<br />
'''POST''' https://rest.sensaphone.net/api/v1/login<br />
<br />
{{TableStart|border_size=1<br />
}}{{TableRowN| '''Request Property''' | '''Status''' | '''Type''' | '''Description'''<br />
}}{{TableRowN| acctid | Required | Integer | Static ID of user<br />
}}{{TableRowN| session | Required | Integer | Session ID of user<br />
}}{{TableRowN| user_name | Optional | String | Username<br />
}}{{TableRowN| password | Optional | String | Password for username<br />
}}{{TableEnd}}<br />
<br><br />
{{TableStart|border_size=1<br />
}}{{TableRowN| '''Response Property''' | '''Included''' | '''Type''' | '''Description'''<br />
}}{{TableRowN| acctid | Conditionally* | Integer | Static ID of user<br />
}}{{TableRowN| session | Conditionally* | Integer | Session ID of user<br />
}}{{TableRowN| login_timestamp | Always | Integer | Time stamp of renewed session<br />
}}{{TableRowN| session_expiration | Always | Integer | Time until new log in session expiration<br />
}}{{TableRowN| user_id | Always | Integer | ID of the logged in user<br />
}}{{TableEnd}}<br />
<nowiki>*</nowiki> There may be an instance where the system needs to create a new Session ID and/or Account ID. In which case, it will be outputted in the PUT response.<br />
<br />
===POST===<br />
'''URI Mode Request URI:'''<br />
*Request for creating a new login session <br />
'''POST''' https://rest.sensaphone.net/api/v1/login/{USERNAME}/{PASSWORD}<br />
'''JSON Mode Request URI:'''<br />
'''POST''' https://rest.sensaphone.net/api/v1/login<br />
<br />
{{TableStart|border_size=1<br />
}}{{TableRowN| '''Request Property''' | '''Status''' | '''Type''' | '''Description'''<br />
}}{{TableRowN| user_name | Required | String | Username<br />
}}{{TableRowN| password | Required | String | Password for username<br />
}}{{TableEnd}}<br />
<br><br />
{{TableStart|border_size=1<br />
}}{{TableRowN| '''Response Property''' | '''Type''' | '''Description'''<br />
}}{{TableRowN| acctid | Integer | Static ID of user<br />
}}{{TableRowN| session | Integer | Session ID of user<br />
}}{{TableRowN| login_timestamp | Integer | Time stamp of renewed session<br />
}}{{TableRowN| session_expiration | Integer | Time until new log in expiration<br />
}}{{TableRowN| user_id | Integer | ID of the logged in user<br />
}}{{TableEnd}}<br />
<br />
===DELETE===<br />
Deleting a login session is the equivalent to logging out. <br />
<br />
'''URI Mode Request URI:'''<br />
*Request to log out of a session <br />
'''DELETE''' https://rest.sensaphone.net/api/v1/{ACCTID}/{SESSION}/login<br />
'''JSON Mode Request URI:'''<br />
'''POST''' https://rest.sensaphone.net/api/v1/login<br />
<br />
{{TableStart|border_size=1<br />
}}{{TableRowN| '''Request Property''' | '''Status''' | '''Type''' | '''Description'''<br />
}}{{TableRowN| acctid | Required | Integer | Static ID of user<br />
}}{{TableRowN| session | Required | Integer | Session ID of user<br />
}}{{TableEnd}}<br />
<br />
==Future==<br />
In the future the login process will support OAuth for advanced access and authentication.<br />
<br />
==Password Reset==<br />
To reset a pass for a particular email, use the following request:<br />
<br />
'''POST''' https://rest.sensaphone.net/api/v1/login/reset_password/{email_address}</div>
Derek
https://wiki.sensaphone.net/index.php?title=Sensaphone.net_API&diff=170
Sensaphone.net API
2017-09-12T14:11:26Z
<p>Derek: </p>
<hr />
<div>==Overview==<br />
The Sensaphone.net API will be used as a resource for proprietary products (such as mobile applications) and 3rd party clients. It uses a [[wikipedia:REST|REST]] architecture over HTTPS using JSON as the data format. HTTP is not supported. The service can be accessed in one of two modes: URI mode and JSON mode.<br />
<br />
In '''''URI mode''''', the following HTTPS methods are used to access the REST resources as [[wikipedia:CRUD|CRUD]].<br />
::{{TableStart|border_size=1<br />
}}{{TableRowN| '''Method''' | '''Description'''<br />
}}{{TableRowN| POST | '''C'''reate<br />
}}{{TableRowN| GET | '''R'''ead<br />
}}{{TableRowN| PUT | '''U'''pdate<br />
}}{{TableRowN| DELETE | '''D'''elete<br />
}}{{TableEnd}}<br />
All parameters are specified in the URI and JSON is only used in the response.<br />
<br />
In '''''JSON Mode''''', only the POST method is used to Create, Read, Update, and Delete fields. A "request_type"(create,read,update,delete) JSON property is used to distinguish which method to execute.<br />
<br />
==Definitions==<br />
:'''Resource''': A resource is a primary source of data. Examples: device, zone.<br />
:'''Property''': A property is a discrete source of data within a resource (e.g. Device's name). A property may also be a resource (e.g. Device's zone).<br />
:'''ID''': Resources have properties that uniquely identify them. For example, a device has a "device_id", a zone has a "zone_id". These identifying properties are optional or required (See [[#URI Syntax|URI Syntax]]) when accessing (read). They are required when modifying (update or delete) a specific existing resource. When creating they are required except for the resource being created. For a create, the newly created ID will typically be returned in the JSON result.<br />
<br />
==URI Syntax==<br />
The URIs are descriptive representations of what the client will receive as a response and will follow one of the formats:<br />
<br />
/api/v1<span style="color:#A00000">[</span>/{''ACCTID''}/{''SESSIONID''}<span style="color:#A00000">]</span>/'''login'''/<span style="color:#A00000">[</span>/{''USERNAME''}/{''PASSWORD''}<span style="color:#A00000">]</span><br />
/api/v1<span style="color:#A00000">[</span>/{''ACCTID''}/{''SESSIONID''}<span style="color:#A00000">]</span><span style="color:#A00000">[</span>/'''Resource'''<span style="color:#A00000">[</span>/{''ID''}<span style="color:#A00000">]]</span>...<span style="color:#A00000">[</span>/'''Resource'''<span style="color:#A00000">[</span>/{''ID''}<span style="color:#A00000">]]</span>/'''Property'''<span style="color:#A00000">[</span>/{''VALUE''}<span style="color:#A00000">]]</span><br />
/api/v1<span style="color:#A00000">[</span>/{''ACCTID''}/{''SESSIONID''}<span style="color:#A00000">]</span><span style="color:#A00000">[</span>/'''Resource'''<span style="color:#A00000">[</span>/{''ID''}<span style="color:#A00000">]]</span>...<span style="color:#A00000">[</span>/'''Resource'''<span style="color:#A00000">[</span>/{''ID''}<span style="color:#A00000">]]</span>/'''Resource'''<span style="color:#A00000">[</span>/{''ID''}<span style="color:#A00000">]]</span><br />
<br />
NOTE: "v1" can be replaced with "v2","v3".<br />
<br />
The "Resource" is the the name of the resource to be accessed (e.g. "device"). The "Property" used will be context dependent and is documented for each resource. Values are placed inside <nowiki>{}</nowiki> brackets. The brackets are used in the URI submitted. <br />
<br />
In [[#Overview|URI Mode]], the Resource ID (e.g. "/''{ID}''") must be included unless it is the rightmost resource in the URI. In [[#Overview|JSON mode]], the ID is still required, but may be included in the submitted JSON instead.<br />
<br />
Fields in <span style="color:#A00000"><nowiki>[]</nowiki></span> brackets are optional on the URI, however, if they are required in the resource documentation, then they must be included '''either''' in the URI or in the JSON, but not both. The brackets themselves are not included in the URI submitted. Consider the following API call to retrieve the device name for device ID 1234:<br />
'''URI Mode Request URI:'''<br />
'''GET''' ''https://rest.sensaphone.net/api/v1/{987654}/{0123-4567-8901}/device/{1234}/name''<br />
The ACCTID, SESSIONID, ID, and "name" fields may be excluded from the URI, but must then be included in the request JSON:<br />
'''Request Description:'''<br />
Retrieve the "name" property from device "1234".<br />
<br />
'''JSON Mode Request URI:'''<br />
'''POST''' ''https://rest.sensaphone.net/api/v1/device''<br />
<br />
'''Request JSON:'''<br />
{<br />
"request_type:"read",<br />
"resource":"device",<br />
"acctid":987654,<br />
"session": "0123-4567-8901",<br />
"device": [<br />
{ <br />
"device_id": 1234,<br />
"name" : null<br />
}<br />
]<br />
}<br />
<br />
This will provide a response of the name of the device whose ID is "1234" for the account with ID 987654 using the Account ID of 987654 and Session ID of "0123-4567-8901":<br />
'''Response JSON:'''<br />
...<br />
{<br />
"device": [<br />
{ <br />
"device_id": 1234,<br />
"name" : "My Device"<br />
}<br />
]<br />
}<br />
...<br />
<br />
The URI method is intended to allow quick access to single pieces of data, but using the JSON method is more complete and allows retrieval of multiple pieces of data at once.<br />
<br />
===Additional Examples===<br />
====POST====<br />
'''Request Description:'''<br />
Create a new alarm schedule for the device with ID 1234 and its zone with ID 112233.<br />
<br />
'''URI Mode Request URI:'''<br />
'''POST''' ''https://rest.sensaphone.net/api/v1/{ACCTID}/{SESSIONID}/device/{1234}/zone/{112233}/alarmschedule<br />
<br />
====GET====<br />
'''Request Description:'''<br />
Retrieve the name of the zone with ID 112233 of the device with ID 1234.<br />
<br />
'''URI Mode Request URI:'''<br />
'''GET''' ''https://rest.sensaphone.net/api/v1/{ACCTID}/{SESSIONID}/device/{1234}/zone/{112233}/name<br />
<br />
====PUT====<br />
'''Request Description:'''<br />
Change the name of the User with the ID 6778 to "John Doe".<br />
<br />
'''URI Mode Request URI:'''<br />
'''PUT''' ''https://rest.sensaphone.net/api/v1/{ACCTID}/{SESSIONID}/user/{6778}/name/{John&nbsp;Doe}''<br />
<br />
====DELETE====<br />
'''Request Description:'''<br />
Delete the User with the ID 6778.<br />
<br />
'''URI Mode Request URI:'''<br />
'''DELETE''' ''https://rest.sensaphone.net/api/v1/{ACCTID}/{SESSIONID}/user/{6778}''<br />
<br />
==JSON Format==<br />
===Requests===<br />
All requests using the JSON mode will only use the POST method with a "request_type" parameter.<br />
<br />
All requests include one outer JSON object unless no request data is specified. Requests are made according the specific requirements of the resource being accessed. With the exception of the login page, a session ID must be included with all API requests. When using the [[#URI Syntax]] JSON mode, the following will be included:<br />
{ &#8592; All values must be within this outer JSON object.<br />
"acctid":987654,<br />
"session": "0123-4567-8901",<br />
"request_type":"read", &#8592; One of "read", "update", "create", "delete"<br />
...<br />
}<br />
<br />
A resource is accessed as either a JSON array of objects or a JSON object. A resource's properties are listed in comma separated values in the JSON object for that resource. All JSON value types may be used. Resources within resources are accessed as JSON objects within objects (or Array of objects). The JSON type of a property is specified by the requirements for each resource. <br />
<br />
When performing a '''Read''' on a resource, all properties will be returned if '''only''' the resource ID is specified. If one or more non-identifying properties are specified, only those properties will be returned. The data values for those ''specific'' properties should be 'null'. <br />
<br />
When performing a '''Delete''', specified non-identifying properties to be deleted should have their data values set to 'null', just like in a '''Read'''.<br />
<br />
When performing a '''Update''' or '''Create''', specified non-identifying properties to be set must have their data values set to valid types, '''not''' 'null'.<br />
<br />
When performing a '''Update''', the identifying properties must be specified. You can't update a resource without identifying it.<br />
<br />
When performing a '''Create''', the identifying properties of the resource being created should not be specified at all. Only existing resources can have identifiers already.<br />
<br />
NOTE: Specifying properties that are not listed in the requirements has no effect.<br />
<br />
'''JSON Mode Request URI:'''<br />
'''POST''' ''https://rest.sensaphone.net/api/v1/device''<br />
<br />
'''Request JSON:'''<br />
{<br />
"request_type":"read",<br />
"resource":"device",<br />
"acctid":987654,<br />
"session": "0123-4567-8901", &#8592; All values are within at least the outer JSON object.<br />
"device":[ &#8592; Devices are accessed as a JSON array of objects.<br />
{ <br />
"device_id": 1234, &#8592; The "device_id" property is provided to identify the device accessed.<br />
"name": null, &#8592; The "name" property is ''specifically'' requested, so it is set to null. The whole device will '''not''' be returned.<br />
"zones":[ &#8592; Zones are accessed as a JSON array of objects.<br />
{ <br />
"zone_id": 112233 &#8592; By only specifying the "zone_id" and no other properties, '''all''' zone data is requested.<br />
} <br />
], <br />
"this fake property": "is ignored" &#8592; Invalid properties are ignored.<br />
}<br />
]<br />
}<br />
<br />
The above request is equivalent to the following requests, but must be done in two steps because two pieces of data were requested (The device's name and the device's zone with the ID 112233). No request JSON is required in this case.<br />
'''URI Mode Request URIs:'''<br />
'''GET''' ''https://rest.sensaphone.net/api/v1/{ACCTID}/{SESSIONID}/device/{1234}/name''<br />
'''GET''' ''https://rest.sensaphone.net/api/v1/{ACCTID}/{SESSIONID}/device/{1234}/zone/{112233}''<br />
<br />
===Responses===<br />
Responses conform to the following format and include error reporting.<br />
<br />
{<br />
"result":<br />
{<br />
"success": true, &#8592; Overall result of the request.<br />
"code": 0, &#8592; Status code for overall result.<br />
"message":"OK", &#8592; String describing the overall result.<br />
<br />
"properties": &#8592; Optionally used for '''Create''', '''Update''', and '''Delete'''<br />
{<br />
"''PROPERTY''":{ &#8592; Property names and layout will match the request.<br />
"success": true,<br />
"message":"OK",<br />
"code":0<br />
},<br />
"''PROPERTY''":{<br />
"success": false,<br />
"message":"Failed",<br />
"code":123<br />
},<br />
...<br />
},<br />
},<br />
"response": &#8592; Any data that may have changed ('''Create'''/'''Update'''/'''Delete''') or been requested ('''Read''').<br />
{<br />
...<br />
}<br />
}<br />
<br />
The success, code, and message for the overall result will always be included. The data in the "response" JSON object will depend on the specification of the resource accessed in the original request, but will generally follow the same layout and format of the request, although the specific properties returned will vary.<br />
<br />
'''JSON Mode Request URI:'''<br />
'''POST''' ''https://rest.sensaphone.net/api/v1/device''<br />
<br />
'''Request JSON:'''<br />
{<br />
"request_type":"update",<br />
"resource":"device",<br />
"acctid":987654,<br />
"session": "0123-4567-8901",<br />
"device":[<br />
{ <br />
"device_id": 1234,<br />
"name": "My Device", &#8592; The device's "name" property is being changed.<br />
"zone":[ <br />
{ <br />
"zone_id": 112233,<br />
"name": 1234 &#8592; The device's zone's "name" property is being changed.<br />
} <br />
]<br />
}<br />
]<br />
}<br />
<br />
'''Response JSON:'''<br />
{<br />
"result":<br />
{<br />
"success": true, &#8592; The overall request was processed correctly, even if some properties had errors.<br />
"code": 0,<br />
"message":"OK",<br />
<br />
"properties":<br />
{<br />
"device":[<br />
{ <br />
"device_id": 1234, &#8592; Identifying properties must be specified.<br />
"name": { &#8592; Property "name" was changed.<br />
"success": true,<br />
"message":"OK",<br />
"code":0<br />
},<br />
"zone":[ <br />
{ <br />
"zone_id": 112233, &#8592; Identifying properties must be specified.<br />
"name": { &#8592; The device's zone's "name" was changed.<br />
"success": false,<br />
"message": "A string type is required",<br />
"code":123<br />
}<br />
} <br />
]<br />
}<br />
]<br />
},<br />
},<br />
"response":<br />
{<br />
"device":[<br />
{ <br />
"device_id": 1234, &#8592; Identifying properties must be specified.<br />
"name": "My Device", &#8592; The new value for the device's "name".<br />
}<br />
]<br />
}<br />
}<br />
<br />
The above request is equivalent to the following requests, but must be done in two steps because two pieces of data were updated (The device's name and the device's zone's name). No request JSON is required in this case.<br />
'''URI Mode Request URIs:'''<br />
'''PUT''' ''https://rest.sensaphone.net/api/v1/{987654}/{0123-4567-8901}/device/{1234}/name/{My&nbsp;Device}''<br />
'''PUT''' ''https://rest.sensaphone.net/api/v1/{987654}/{0123-4567-8901}/device/{1234}/zone/{112233}/name/{1234}''<br />
<br />
The following are some of the status codes used for overall status.<br />
::{{TableStart|border_size=1<br />
}}{{TableRowN| '''Code''' | '''Description'''<br />
}}{{TableRowN| 0 | Success<br />
}}{{TableRowN| 1 | Failed: No Session ID provided<br />
}}{{TableRowN| 2 | Failed: Session ID has expired<br />
}}{{TableRowN| 3 | Failed: Invalid request URI.<br />
}}{{TableRowN| 4 | Failed: Invalid request JSON.<br />
}}{{TableRowN| 5 | Failed: Invalid username provided.<br />
}}{{TableRowN| 6 | Failed: Invalid password provided.<br />
}}{{TableRowN| 7 | Failed: User is not authorized.<br />
}}{{TableRowN| 8 | Failed: Service unavailable. Try again later.<br />
}}{{TableEnd}}<br />
<br />
==Versions==<br />
There will be three versions of the API. We will refer to them as V1, V2, and V3. The only difference between the versions is in the format of '''responses'''. Requests to the Sensaphone.net API are identical in all cases.<br />
<br />
===V1===<br />
V1 will primarily be used to give responses that will be directly displayed in a client's application. <br />
<br />
'''Example V1 Response for "https://rest.sensaphone.net/api/v1/{987654}/{0123-4567-8901}/device/{1234}/name" :'''<br />
<br />
{<br />
"device": [<br />
{ <br />
"device_id": 1234,<br />
"name" : "My Device"<br />
}<br />
]<br />
}<br />
<br />
===V2===<br />
V2 should be used when responses with the addition of metadata are needed.<br />
<br />
'''Example V2 Response for "https://rest.sensaphone.net/api/v2/{987654}/{0123-4567-8901}/device/{1234}/name" :''' <br />
{<br />
"device": [<br />
{ <br />
"device_id": 1234,<br />
"name": <br />
{<br />
"is_null" : false,<br />
"is_empty": false,<br />
"value" : "Device 1",<br />
"type" : "string",<br />
"is_pending": false,<br />
"is_ranged" : true,<br />
"ranged":[<br />
{<br />
"null": false,<br />
"min" : 0,<br />
"max" : 128<br />
}<br />
]<br />
}<br />
}<br />
]<br />
}<br />
<br />
::{{TableStart|border_size=1<br />
}}{{TableRowN| '''Property''' | '''Status''' | '''Type''' | '''Description'''<br />
}}{{TableRowN| is_null | Required | Boolean | States if the corresponding value is NULL. If so, no additional keys are given.<br />
}}{{TableRowN| is_empty | Required* | Boolean | States if the corresponding value is empty. If so, no additional keys are given.<br />
}}{{TableRowN| value | Required** | String | Description of the corresponding value<br />
}}{{TableRowN| type | Required** | String | Type of value<br />
}}{{TableRowN| is_pending | Optional | Boolean | States if the value is in process of being updated<br />
}}{{TableRowN| is_ranged | Optional | Boolean | States if there is a set of ranges for the value<br />
}}{{TableRowN| ranged | Optional | Array | Array of ranges<br />
}}{{TableRowN| &#8594; null | Required | Boolean | States if the value can be null.<br />
}}{{TableRowN| &#8594; min | Required*** | Mixed | Min of range<br />
}}{{TableRowN| &#8594; max | Optional | Mixed | Max of range<br />
}}{{TableEnd}}<br />
::<nowiki>*</nowiki> Only required if "is_null" is false.<br />
::<nowiki>**</nowiki> Only required if "is_empty" is false.<br />
::<nowiki>***</nowiki> Only required if "null" is false.<br />
<br />
<br />
===V3===<br />
V3 should be used when only the pending meta data is needed<br />
<br />
'''Example V3 Response for "https://rest.sensaphone.net/api/v3/{987654}/{0123-4567-8901}/device/{1234}/name" :'''<br />
<br />
{<br />
"device": [<br />
{ <br />
"device_id": 1234,<br />
"name" : <br />
{<br />
"is_pending": true<br />
}<br />
}<br />
]<br />
}<br />
<br />
==Resources==<br />
The following resources are accessible through the REST API. They may be accessible from different URI contexts. See the individual resource pages for more information.<br />
::{{TableStart|border_size=1<br />
}}{{TableRowN|'''Page''' |'''GET'''|'''PUT'''|'''POST'''|'''DELETE'''<br />
}}{{TableRowN|&nbsp; |(Read)|(Write)|(Create)|(Delete)<br />
}}{{TableRowN|[[{{PAGENAME}}/login|login]] |Y|Y|Y|Y<br />
}}{{TableRowN|[[{{PAGENAME}}/dashboard|dashboard]] |Y|N|N|N<br />
}}{{TableRowN|[[{{PAGENAME}}/history|history]] |Y|N|N|N<br />
}}{{TableRowN|[[{{PAGENAME}}/account|account]] |Y|Y|N|N<br />
}}{{TableRowN|[[{{PAGENAME}}/feature|feature]] |Y|Y|N|N<br />
}}{{TableRowN|[[{{PAGENAME}}/device|device]] |Y|Y|Y|Y<br />
}}{{TableRowN|[[{{PAGENAME}}/devicegroup|devicegroup]] |Y|Y|Y|Y<br />
}}{{TableRowN|[[{{PAGENAME}}/address|address]] |Y|Y|N|N<br />
}}{{TableRowN|[[{{PAGENAME}}/coordinates|coordinates]] |Y|Y|N|N<br />
}}{{TableRowN|[[{{PAGENAME}}/zone|zone]] |Y|Y|Y|N<br />
}}{{TableRowN|[[{{PAGENAME}}/calllist|calllist]] |Y|Y|Y|Y<br />
}}{{TableRowN|[[{{PAGENAME}}/alarmschedule|alarmschedule]] |Y|Y|Y|Y<br />
}}{{TableRowN|[[{{PAGENAME}}/schedule|schedule]] |Y|Y|Y|Y<br />
}}{{TableRowN|[[{{PAGENAME}}/timerange|timerange]] |Y|Y|Y|Y<br />
}}{{TableRowN|[[{{PAGENAME}}/contactgroup|contactgroup]] |Y|Y|Y|Y<br />
}}{{TableRowN|[[{{PAGENAME}}/user|user]] |Y|Y|Y|Y<br />
}}{{TableRowN|[[{{PAGENAME}}/contact|contact]] |Y|Y|Y|Y<br />
}}{{TableEnd}}<br />
<br />
===List===<br />
The following is a list of all possible REST resources, excluding any possible '''<nowiki>[/Property/[/Value]]</nowiki>''' suffix. Properties ('''/Property''') of a resource are shown where it is a JSON object or array of objects (e.g. "alarmschedule"). For a full list of properties and values associated with each resource, see the page for that resource.<br />
*/api/v1/login/{USERNAME}/{PASSWORD}<br />
*/api/v1/{ACCTID}/{SESSIONID}/account<br />
*/api/v1/{ACCTID}/{SESSIONID}/account/feature<br />
*/api/v1/{ACCTID}/{SESSIONID}/calllist<br />
*/api/v1/{ACCTID}/{SESSIONID}/contact<br />
*/api/v1/{ACCTID}/{SESSIONID}/contact/schedule<br />
*/api/v1/{ACCTID}/{SESSIONID}/contact/schedule/timerange<br />
*/api/v1/{ACCTID}/{SESSIONID}/contactgroup<br />
*/api/v1/{ACCTID}/{SESSIONID}/dashboard<br />
*/api/v1/{ACCTID}/{SESSIONID}/device<br />
*/api/v1/{ACCTID}/{SESSIONID}/device/default_schedule<br />
*/api/v1/{ACCTID}/{SESSIONID}/device/default_schedule/timerange<br />
*/api/v1/{ACCTID}/{SESSIONID}/device/default_schedule/calllist<br />
*/api/v1/{ACCTID}/{SESSIONID}/device/device_schedule<br />
*/api/v1/{ACCTID}/{SESSIONID}/device/device_schedule/timerange<br />
*/api/v1/{ACCTID}/{SESSIONID}/device/device_schedule/calllist<br />
*/api/v1/{ACCTID}/{SESSIONID}/device/feature<br />
*/api/v1/{ACCTID}/{SESSIONID}/device/location<br />
*/api/v1/{ACCTID}/{SESSIONID}/device/location/address<br />
*/api/v1/{ACCTID}/{SESSIONID}/device/location/coordinates<br />
*/api/v1/{ACCTID}/{SESSIONID}/device/zone<br />
*/api/v1/{ACCTID}/{SESSIONID}/device/zone/alarm_zone/alarmschedule<br />
*/api/v1/{ACCTID}/{SESSIONID}/device/zone/alarm_zone/alarmschedule/timerange<br />
*/api/v1/{ACCTID}/{SESSIONID}/device/zone/alarm_zone/alarmschedule/calllist<br />
*/api/v1/{ACCTID}/{SESSIONID}/device/zone/schedule<br />
*/api/v1/{ACCTID}/{SESSIONID}/device/zone/schedule/timerange<br />
*/api/v1/{ACCTID}/{SESSIONID}/devicegroup<br />
*/api/v1/{ACCTID}/{SESSIONID}/history<br />
*/api/v1/{ACCTID}/{SESSIONID}/login<br />
*/api/v1/{ACCTID}/{SESSIONID}/user<br />
*/api/v1/{ACCTID}/{SESSIONID}/user/alarm_user/contact<br />
*/api/v1/{ACCTID}/{SESSIONID}/user/alarm_user/contact/schedule<br />
*/api/v1/{ACCTID}/{SESSIONID}/user/alarm_user/contact/schedule/timerange<br />
*/api/v1/{ACCTID}/{SESSIONID}/user/alarm_user/schedule<br />
*/api/v1/{ACCTID}/{SESSIONID}/user/alarm_user/schedule/timerange<br />
*/api/v1/{ACCTID}/{SESSIONID}/user/site_user/address<br />
<br />
==Help==<br />
If you need help using our API and your question isn't answered in the wiki, please feel free to email us at: [mailto:api@sensaphone.net api@sensaphone.net]</div>
Derek
https://wiki.sensaphone.net/index.php?title=Sensaphone.net_API/dashboard&diff=169
Sensaphone.net API/dashboard
2017-09-07T21:14:05Z
<p>Derek: /* Example */</p>
<hr />
<div>=[[Sensaphone.net API]]=<br />
<br />
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.<br />
<br />
==Example Call==<br />
<br />
http://rest.sensaphone.net/api/v1/{ACCTID}/{UUID}/dashboard<br />
<br />
==Example Requests==<br />
===GET===<br />
'''URI Mode Request URI's:''' <br />
*Receive all Dashboard information <br />
'''GET''' https://rest.sensaphone.net/api/v1/{ACCTID}/{UUID}/dashboard<br />
<br />
*Receive for the number of Devices online <br />
'''GET''' https://rest.sensaphone.net/api/v1/{ACCTID}/{UUID}/dashboard/devices_online<br />
<br />
*Receive the names of all Devices powered on and online <br />
'''GET''' https://rest.sensaphone.net/api/v1/{ACCTID}/{UUID}/dashboard/device/name<br />
'''JSON Mode Request URI:'''<br />
'''POST''' https://rest.sensaphone.net/api/v1/dashboard <br />
<br />
'''JSON Mode Request Properties'''<br />
{{TableStart|border_size=1<br />
}}{{TableRowN| '''Parent Property'''|'''Child Property''' |'''Type''' | '''Description'''<br />
}}{{TableRowN| &nbsp; | acctid | Integer | Account ID<br />
}}{{TableRowN| &nbsp; | session | String | Session ID<br />
}}{{TableRowN| &nbsp; | request_type | String | "read"<br />
}}{{TableRowN| &nbsp; | dashboard | Object | The dashboard object.<br />
}}{{TableEnd}}<br />
<br><br />
'''JSON Mode Response Properties'''<br />
{{TableStart|border_size=1<br />
}}{{TableRowN| '''Parent Property''' |'''Child Property'''|'''Status'''| '''Type''' | '''Description'''<br />
}}{{TableRowN| &nbsp; | dashboard | Required | Object | The dashboard object.<br />
}}{{TableRowN| dashboard | online_count | Optional | Integer | Number of Devices turned on and online<br />
}}{{TableRowN| dashboard | offline_count | Optional | Integer | Number of Devices offline<br />
}}{{TableRowN| dashboard | alarm_count | Optional | Integer | Number of acknowledged alarms<br />
}}{{TableRowN| dashboard | unack_count | Optional | Integer | Number of unacknowledged alarms<br />
}}{{TableRowN| dashboard | total_alarm_count | Optional | Integer | Number of alarms<br />
}}{{TableRowN| dashboard | device | Optional | Array | Array of Devices<br />
}}{{TableRowN| device | device_id | Optional | Integer | ID of Device<br />
}}{{TableRowN| device | id | Optional | Integer | Unique identifier located on the Device (Serial number, etc.)<br />
}}{{TableRowN| device | name | Optional | String | Name of Device<br />
}}{{TableRowN| device | location | Optional | Object | Contains location information for the device.<br />
}}{{TableRowN| location | address | Optional | Object | Address information for Device (See [[Sensaphone.net API/address]])<br />
}}{{TableRowN| location | coordinates | Optional | Object | GPS Coordinates information for Device (See [[Sensaphone.net API/coordinates]])<br />
}}{{TableRowN| device | status | Optional | String | Alarm status of Device("OK" or "Alarm")<br />
}}{{TableRowN| device | is_offline_unack | Optional | Boolean | Whether or not an '''unacknowledged''' offline alarm exists.<br />
}}{{TableRowN| device | is_online | Optional | Boolean | Whether or not the device is currently online.<br />
}}{{TableRowN| device | battery_status | Optional | String | A device's battery status <br />
}}{{TableRowN| device | power_status | Optional | String | A device's power status <br />
}}{{TableRowN| device | battery_value | Optional | String | A device's battery value <br />
}}{{TableRowN| device | power_value | Optional | String | A device's power value <br />
}}{{TableRowN| device | connection_status | Optional | String | A device's connection status <br />
}}{{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<br />
}}{{TableRowN| zone | canonical_name | Optional | String | Canonical name of the zone.<br />
}}{{TableRowN| zone | value | Optional | String | The data value for the zone.<br />
}}{{TableRowN| zone | type | Optional | String | The zone type.<br />
}}{{TableRowN| zone | alarm_zone | Optional | Object | Sub-object containing data for alarmable zones. 'null' if unsupported.<br />
}}{{TableRowN| alarm_zone | alarm_status | Optional | Array of ZoneState | The processed status of the zone ( returns 2 ZoneStates)<br />
}}{{TableRowN| alarm_zone | unack_alarms | Optional | Array of ZoneState | Alarm states that are currently unacknowledged <br />
}}{{TableEnd}}<br />
<br />
<br />
====Example====<br />
This example is requesting the '''devices_online''' and '''name''' values.<br />
<br />
*'''Request JSON''' <br />
{<br />
"request_type": "read",<br />
"resource": "dashboard",<br />
"acctid": 12345678,<br />
"session": "123a-456b-789c",<br />
"dashboard": {<br />
"online_count": null,<br />
"device": [{<br />
"name": null<br />
}]<br />
}<br />
}<br />
<br />
*'''Result JSON'''<br />
<br />
{<br />
"response": {<br />
"dashboard": {<br />
"device": [<br />
{<br />
"device_id": 9876,<br />
"name": "A device"<br />
},<br />
{<br />
"device_id": 5432,<br />
"name": "Another device"<br />
}<br />
],<br />
"online_count": 2<br />
}<br />
},<br />
"result": {<br />
"code": 0,<br />
"message": "OK",<br />
"success": true<br />
}<br />
}</div>
Derek
https://wiki.sensaphone.net/index.php?title=Sensaphone.net_API/dashboard&diff=168
Sensaphone.net API/dashboard
2017-09-07T20:50:58Z
<p>Derek: </p>
<hr />
<div>=[[Sensaphone.net API]]=<br />
<br />
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.<br />
<br />
==Example Call==<br />
<br />
http://rest.sensaphone.net/api/v1/{ACCTID}/{UUID}/dashboard<br />
<br />
==Example Requests==<br />
===GET===<br />
'''URI Mode Request URI's:''' <br />
*Receive all Dashboard information <br />
'''GET''' https://rest.sensaphone.net/api/v1/{ACCTID}/{UUID}/dashboard<br />
<br />
*Receive for the number of Devices online <br />
'''GET''' https://rest.sensaphone.net/api/v1/{ACCTID}/{UUID}/dashboard/devices_online<br />
<br />
*Receive the names of all Devices powered on and online <br />
'''GET''' https://rest.sensaphone.net/api/v1/{ACCTID}/{UUID}/dashboard/device/name<br />
'''JSON Mode Request URI:'''<br />
'''POST''' https://rest.sensaphone.net/api/v1/dashboard <br />
<br />
'''JSON Mode Request Properties'''<br />
{{TableStart|border_size=1<br />
}}{{TableRowN| '''Parent Property'''|'''Child Property''' |'''Type''' | '''Description'''<br />
}}{{TableRowN| &nbsp; | acctid | Integer | Account ID<br />
}}{{TableRowN| &nbsp; | session | String | Session ID<br />
}}{{TableRowN| &nbsp; | request_type | String | "read"<br />
}}{{TableRowN| &nbsp; | dashboard | Object | The dashboard object.<br />
}}{{TableEnd}}<br />
<br><br />
'''JSON Mode Response Properties'''<br />
{{TableStart|border_size=1<br />
}}{{TableRowN| '''Parent Property''' |'''Child Property'''|'''Status'''| '''Type''' | '''Description'''<br />
}}{{TableRowN| &nbsp; | dashboard | Required | Object | The dashboard object.<br />
}}{{TableRowN| dashboard | online_count | Optional | Integer | Number of Devices turned on and online<br />
}}{{TableRowN| dashboard | offline_count | Optional | Integer | Number of Devices offline<br />
}}{{TableRowN| dashboard | alarm_count | Optional | Integer | Number of acknowledged alarms<br />
}}{{TableRowN| dashboard | unack_count | Optional | Integer | Number of unacknowledged alarms<br />
}}{{TableRowN| dashboard | total_alarm_count | Optional | Integer | Number of alarms<br />
}}{{TableRowN| dashboard | device | Optional | Array | Array of Devices<br />
}}{{TableRowN| device | device_id | Optional | Integer | ID of Device<br />
}}{{TableRowN| device | id | Optional | Integer | Unique identifier located on the Device (Serial number, etc.)<br />
}}{{TableRowN| device | name | Optional | String | Name of Device<br />
}}{{TableRowN| device | location | Optional | Object | Contains location information for the device.<br />
}}{{TableRowN| location | address | Optional | Object | Address information for Device (See [[Sensaphone.net API/address]])<br />
}}{{TableRowN| location | coordinates | Optional | Object | GPS Coordinates information for Device (See [[Sensaphone.net API/coordinates]])<br />
}}{{TableRowN| device | status | Optional | String | Alarm status of Device("OK" or "Alarm")<br />
}}{{TableRowN| device | is_offline_unack | Optional | Boolean | Whether or not an '''unacknowledged''' offline alarm exists.<br />
}}{{TableRowN| device | is_online | Optional | Boolean | Whether or not the device is currently online.<br />
}}{{TableRowN| device | battery_status | Optional | String | A device's battery status <br />
}}{{TableRowN| device | power_status | Optional | String | A device's power status <br />
}}{{TableRowN| device | battery_value | Optional | String | A device's battery value <br />
}}{{TableRowN| device | power_value | Optional | String | A device's power value <br />
}}{{TableRowN| device | connection_status | Optional | String | A device's connection status <br />
}}{{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<br />
}}{{TableRowN| zone | canonical_name | Optional | String | Canonical name of the zone.<br />
}}{{TableRowN| zone | value | Optional | String | The data value for the zone.<br />
}}{{TableRowN| zone | type | Optional | String | The zone type.<br />
}}{{TableRowN| zone | alarm_zone | Optional | Object | Sub-object containing data for alarmable zones. 'null' if unsupported.<br />
}}{{TableRowN| alarm_zone | alarm_status | Optional | Array of ZoneState | The processed status of the zone ( returns 2 ZoneStates)<br />
}}{{TableRowN| alarm_zone | unack_alarms | Optional | Array of ZoneState | Alarm states that are currently unacknowledged <br />
}}{{TableEnd}}<br />
<br />
<br />
====Example====<br />
This example is requesting the '''devices_online''' and '''name''' values.<br />
<br />
*'''Request JSON''' <br />
{<br />
"request_type":"read",<br />
"resource":"dashboard",<br />
"acctid":987654,<br />
"session":"0123-4567-8901",<br />
"online_count": null,<br />
"device":<br />
{<br />
"name":null<br />
}<br />
}<br />
<br />
*'''Result JSON'''<br />
<br />
{<br />
"result":<br />
{ <br />
"success":true,<br />
"code":0,<br />
"message":"OK:,<br />
},<br />
"response": <br />
{ <br />
"online_count":3,<br />
"device":<br />
{<br />
"name":"Device 1",<br />
"name":"Device 2",<br />
"name":"Device 3"<br />
}<br />
}<br />
}</div>
Derek
https://wiki.sensaphone.net/index.php?title=Sensaphone.net_API/login&diff=167
Sensaphone.net API/login
2017-09-07T20:49:32Z
<p>Derek: </p>
<hr />
<div>=[[Sensaphone.net API]]=<br />
<br />
The Login API will be used to log in to the Sensaphone.net system. When a user logs in with their username and password they will be assigned a session UUID. The session UUID will have a corresponding time stamp and a timed expiration for their session. The session UUID and statically assigned Account ID will be used as the primary identifier instead of including a username and password in subsequent URI requests. <br />
<br />
==Example Call==<br />
https://sensaphone.net/api/v1/login/{USERNAME}/{PASSWORD}<br />
<br />
==Values==<br />
*Username<br />
*Password<br />
*Session UUID<br />
*Session Time stamp<br />
*Session Expiration<br />
<br />
==Example Requests==<br />
===GET===<br />
'''URI Mode Request URI's:'''<br />
*Receive Login information <br />
'''GET''' https://rest.sensaphone.net/api/v1/{ACCTID}/{SESSION}/login<br />
*Receive a Login timestamp for a session <br />
'''GET''' https://rest.sensaphone.net/api/v1/{ACCTID}/{SESSION}/login/login_timestamp<br />
*Receive the number of seconds until a session expires <br />
'''GET''' https://rest.sensaphone.net/api/v1/{ACCTID}/{SESSION}/login/session_expiration <br />
<br />
'''JSON MODE Request URI:'''<br />
*Receive Login information <br />
'''POST''' https://rest.sensaphone.net/api/v1/login<br />
<br />
{{TableStart|border_size=1<br />
}}{{TableRowN| '''Request Property''' | '''Status''' | '''Type''' | '''Description'''<br />
}}{{TableRowN| acctid | Required | Integer | Static ID of user<br />
}}{{TableRowN| session | Required | Integer | Session ID of user<br />
}}{{TableEnd}}<br />
<br><br />
{{TableStart|border_size=1<br />
}}{{TableRowN| '''Response Property''' | '''Included''' | '''Type''' | '''Description'''<br />
}}{{TableRowN| login_timestamp | Optional | String | Time stamp of last log in<br />
}}{{TableRowN| session_expiration | Optional | Integer | Seconds until log in expiration<br />
}}{{TableRowN| user_id | Optional | Integer | ID of the logged in user<br />
}}{{TableEnd}}<br />
<br />
====Example JSON====<br />
Log in with a username and password using JSON mode.<br />
*'''Request JSON:'''<br />
{<br />
"request_type":"create",<br />
"resource": "login",<br />
"user_name": "myusername",<br />
"password": "pass123"<br />
}<br />
<br />
*'''Response JSON:'''<br />
{<br />
"result": {<br />
"success": true,<br />
"code": 0,<br />
"message": "Success"<br />
},<br />
"response": {<br />
"acctid": 987654,<br />
"session": "0123-4567-8901",<br />
"login_timestamp": 1499459402,<br />
"session_expiration": 86400,<br />
"user_id": 00000001<br />
}<br />
}<br />
<br />
Receive Login information for a given session UUID.<br />
<br />
*'''Request JSON:'''<br />
{<br />
"request_type:"read",<br />
"resource":"login",<br />
"acctid":987654,<br />
"session":"0123-4567-8901",<br />
"login":null<br />
}<br />
<br />
*'''Response JSON:'''<br />
{<br />
"result":<br />
{<br />
"success: true,<br />
"code": 0,<br />
"message":"OK",<br />
},<br />
"response":<br />
{<br />
"login_timestamp":"2014-12-31 23:59:59",<br />
"session_expiration":60<br />
}<br />
}<br />
<br />
===PUT===<br />
PUT will be used only to update a Login session.<br />
<br />
'''URI Mode Request URI:'''<br />
*Request to update a Login session <br />
'''PUT''' https://rest.sensaphone.net/api/v1/{ACCTID}/{SESSION}/login<br />
'''JSON Mode Request URI:'''<br />
'''POST''' https://rest.sensaphone.net/api/v1/login<br />
<br />
{{TableStart|border_size=1<br />
}}{{TableRowN| '''Request Property''' | '''Status''' | '''Type''' | '''Description'''<br />
}}{{TableRowN| acctid | Required | Integer | Static ID of user<br />
}}{{TableRowN| session | Required | Integer | Session ID of user<br />
}}{{TableRowN| user_name | Optional | String | Username<br />
}}{{TableRowN| password | Optional | String | Password for username<br />
}}{{TableEnd}}<br />
<br><br />
{{TableStart|border_size=1<br />
}}{{TableRowN| '''Response Property''' | '''Included''' | '''Type''' | '''Description'''<br />
}}{{TableRowN| acctid | Conditionally* | Integer | Static ID of user<br />
}}{{TableRowN| session | Conditionally* | Integer | Session ID of user<br />
}}{{TableRowN| login_timestamp | Always | Integer | Time stamp of renewed session<br />
}}{{TableRowN| session_expiration | Always | Integer | Time until new log in session expiration<br />
}}{{TableRowN| user_id | Always | Integer | ID of the logged in user<br />
}}{{TableEnd}}<br />
<nowiki>*</nowiki> There may be an instance where the system needs to create a new Session ID and/or Account ID. In which case, it will be outputted in the PUT response.<br />
<br />
===POST===<br />
'''URI Mode Request URI:'''<br />
*Request for creating a new login session <br />
'''POST''' https://rest.sensaphone.net/api/v1/login/{USERNAME}/{PASSWORD}<br />
'''JSON Mode Request URI:'''<br />
'''POST''' https://rest.sensaphone.net/api/v1/login<br />
<br />
{{TableStart|border_size=1<br />
}}{{TableRowN| '''Request Property''' | '''Status''' | '''Type''' | '''Description'''<br />
}}{{TableRowN| user_name | Required | String | Username<br />
}}{{TableRowN| password | Required | String | Password for username<br />
}}{{TableEnd}}<br />
<br><br />
{{TableStart|border_size=1<br />
}}{{TableRowN| '''Response Property''' | '''Type''' | '''Description'''<br />
}}{{TableRowN| acctid | Integer | Static ID of user<br />
}}{{TableRowN| session | Integer | Session ID of user<br />
}}{{TableRowN| login_timestamp | Integer | Time stamp of renewed session<br />
}}{{TableRowN| session_expiration | Integer | Time until new log in expiration<br />
}}{{TableRowN| user_id | Integer | ID of the logged in user<br />
}}{{TableEnd}}<br />
<br />
===DELETE===<br />
Deleting a login session is the equivalent to logging out. <br />
<br />
'''URI Mode Request URI:'''<br />
*Request to log out of a session <br />
'''DELETE''' https://rest.sensaphone.net/api/v1/login/{ACCTID}/{SESSION}<br />
'''JSON Mode Request URI:'''<br />
'''POST''' https://rest.sensaphone.net/api/v1/login<br />
<br />
{{TableStart|border_size=1<br />
}}{{TableRowN| '''Request Property''' | '''Status''' | '''Type''' | '''Description'''<br />
}}{{TableRowN| acctid | Required | Integer | Static ID of user<br />
}}{{TableRowN| session | Required | Integer | Session ID of user<br />
}}{{TableEnd}}<br />
<br />
==Future==<br />
In the future the login process will support OAuth for advanced access and authentication.<br />
<br />
==Password Reset==<br />
To reset a pass for a particular email, use the following request:<br />
<br />
'''POST''' https://rest.sensaphone.net/api/v1/login/reset_password/{email_address}</div>
Derek
https://wiki.sensaphone.net/index.php?title=Sensaphone.net_API/login&diff=166
Sensaphone.net API/login
2017-07-07T20:40:34Z
<p>Derek: </p>
<hr />
<div>=[[Sensaphone.net API]]=<br />
<br />
The Login API will be used to log in to the Sensaphone.net system. When a user logs in with their username and password they will be assigned a session UUID. The session UUID will have a corresponding time stamp and a timed expiration for their session. The session UUID and statically assigned Account ID will be used as the primary identifier instead of including a username and password in subsequent URI requests. <br />
<br />
==Example Call==<br />
https://sensaphone.net/api/v1/login/{USERNAME}/{PASSWORD}<br />
<br />
==Values==<br />
*Username<br />
*Password<br />
*Session UUID<br />
*Session Time stamp<br />
*Session Expiration<br />
<br />
==Example Requests==<br />
===GET===<br />
'''URI Mode Request URI's:'''<br />
*Receive Login information <br />
'''GET''' https://rest.sensaphone.net/api/v1/{ACCTID}/{SESSION}/login<br />
*Receive a Login timestamp for a session <br />
'''GET''' https://rest.sensaphone.net/api/v1/{ACCTID}/{SESSION}/login/login_timestamp<br />
*Receive the number of seconds until a session expires <br />
'''GET''' https://rest.sensaphone.net/api/v1/{ACCTID}/{SESSION}/login/session_expiration <br />
<br />
'''JSON MODE Request URI:'''<br />
*Receive Login information <br />
'''POST''' https://rest.sensaphone.net/api/v1/login<br />
<br />
{{TableStart|border_size=1<br />
}}{{TableRowN| '''Request Property''' | '''Status''' | '''Type''' | '''Description'''<br />
}}{{TableRowN| acctid | Required | Integer | Static ID of user<br />
}}{{TableRowN| session | Required | Integer | Session ID of user<br />
}}{{TableEnd}}<br />
<br><br />
{{TableStart|border_size=1<br />
}}{{TableRowN| '''Response Property''' | '''Included''' | '''Type''' | '''Description'''<br />
}}{{TableRowN| login_timestamp | Optional | String | Time stamp of last log in<br />
}}{{TableRowN| session_expiration | Optional | Integer | Seconds until log in expiration<br />
}}{{TableRowN| user_id | Optional | Integer | ID of the logged in user<br />
}}{{TableEnd}}<br />
<br />
====Example JSON====<br />
Log in with a username and password using JSON mode.<br />
*'''Request JSON:'''<br />
{<br />
"request_type:"create",<br />
"resource": "login",<br />
"user_name": "myusername",<br />
"password": "pass123"<br />
}<br />
<br />
*'''Response JSON:'''<br />
{<br />
"result": {<br />
"success": true,<br />
"code": 0,<br />
"message": "Success"<br />
},<br />
"response": {<br />
"acctid": 987654,<br />
"session": "0123-4567-8901",<br />
"login_timestamp": 1499459402,<br />
"session_expiration": 86400,<br />
"user_id": 00000001<br />
}<br />
}<br />
<br />
Receive Login information for a given session UUID.<br />
<br />
*'''Request JSON:'''<br />
{<br />
"request_type:"read",<br />
"resource":"login",<br />
"acctid":987654,<br />
"session":"0123-4567-8901",<br />
"login":null<br />
}<br />
<br />
*'''Response JSON:'''<br />
{<br />
"result":<br />
{<br />
"success: true,<br />
"code": 0,<br />
"message":"OK",<br />
},<br />
"response":<br />
{<br />
"login_timestamp":"2014-12-31 23:59:59",<br />
"session_expiration":60<br />
}<br />
}<br />
<br />
===PUT===<br />
PUT will be used only to update a Login session.<br />
<br />
'''URI Mode Request URI:'''<br />
*Request to update a Login session <br />
'''PUT''' https://rest.sensaphone.net/api/v1/{ACCTID}/{SESSION}/login<br />
'''JSON Mode Request URI:'''<br />
'''POST''' https://rest.sensaphone.net/api/v1/login<br />
<br />
{{TableStart|border_size=1<br />
}}{{TableRowN| '''Request Property''' | '''Status''' | '''Type''' | '''Description'''<br />
}}{{TableRowN| acctid | Required | Integer | Static ID of user<br />
}}{{TableRowN| session | Required | Integer | Session ID of user<br />
}}{{TableRowN| user_name | Optional | String | Username<br />
}}{{TableRowN| password | Optional | String | Password for username<br />
}}{{TableEnd}}<br />
<br><br />
{{TableStart|border_size=1<br />
}}{{TableRowN| '''Response Property''' | '''Included''' | '''Type''' | '''Description'''<br />
}}{{TableRowN| acctid | Conditionally* | Integer | Static ID of user<br />
}}{{TableRowN| session | Conditionally* | Integer | Session ID of user<br />
}}{{TableRowN| login_timestamp | Always | Integer | Time stamp of renewed session<br />
}}{{TableRowN| session_expiration | Always | Integer | Time until new log in session expiration<br />
}}{{TableRowN| user_id | Always | Integer | ID of the logged in user<br />
}}{{TableEnd}}<br />
<nowiki>*</nowiki> There may be an instance where the system needs to create a new Session ID and/or Account ID. In which case, it will be outputted in the PUT response.<br />
<br />
===POST===<br />
'''URI Mode Request URI:'''<br />
*Request for creating a new login session <br />
'''POST''' https://rest.sensaphone.net/api/v1/login/{USERNAME}/{PASSWORD}<br />
'''JSON Mode Request URI:'''<br />
'''POST''' https://rest.sensaphone.net/api/v1/login<br />
<br />
{{TableStart|border_size=1<br />
}}{{TableRowN| '''Request Property''' | '''Status''' | '''Type''' | '''Description'''<br />
}}{{TableRowN| user_name | Required | String | Username<br />
}}{{TableRowN| password | Required | String | Password for username<br />
}}{{TableEnd}}<br />
<br><br />
{{TableStart|border_size=1<br />
}}{{TableRowN| '''Response Property''' | '''Type''' | '''Description'''<br />
}}{{TableRowN| acctid | Integer | Static ID of user<br />
}}{{TableRowN| session | Integer | Session ID of user<br />
}}{{TableRowN| login_timestamp | Integer | Time stamp of renewed session<br />
}}{{TableRowN| session_expiration | Integer | Time until new log in expiration<br />
}}{{TableRowN| user_id | Integer | ID of the logged in user<br />
}}{{TableEnd}}<br />
<br />
===DELETE===<br />
Deleting a login session is the equivalent to logging out. <br />
<br />
'''URI Mode Request URI:'''<br />
*Request to log out of a session <br />
'''DELETE''' https://rest.sensaphone.net/api/v1/login/{ACCTID}/{SESSION}<br />
'''JSON Mode Request URI:'''<br />
'''POST''' https://rest.sensaphone.net/api/v1/login<br />
<br />
{{TableStart|border_size=1<br />
}}{{TableRowN| '''Request Property''' | '''Status''' | '''Type''' | '''Description'''<br />
}}{{TableRowN| acctid | Required | Integer | Static ID of user<br />
}}{{TableRowN| session | Required | Integer | Session ID of user<br />
}}{{TableEnd}}<br />
<br />
==Future==<br />
In the future the login process will support OAuth for advanced access and authentication.<br />
<br />
==Password Reset==<br />
To reset a pass for a particular email, use the following request:<br />
<br />
'''POST''' https://rest.sensaphone.net/api/v1/login/reset_password/{email_address}</div>
Derek
https://wiki.sensaphone.net/index.php?title=Sensaphone.net_API/zone&diff=165
Sensaphone.net API/zone
2017-06-09T18:18:28Z
<p>Derek: /* PUT */</p>
<hr />
<div>=[[Sensaphone.net API]]=<br />
<br />
==Specifications==<br />
Different zones types may have different configurable properties than others. For example, a '''''2.8k Thermistor F''''' type Zone will have '''''calibration''''', '''''alarm low''''', and '''''alarm high''''' but a '''''Normally Open''''' type zone will not. If a request is made for a property not belonging to a zone type an error will be issued. Below is a chart showing the relations. A property is only available if the type metadata (The '''type_list''' property) has the checked options enabled. Whether or not the above properties correspond with a particular zone type is defined in the meta data for the zone types '''(included in v2 but not v1 of the API)'''. In addition, a property may be disabled at the global scale if it is 'null', regardless of this table. For example, the zone type's meta indicates that it is "External" but the "wireless_zone" field is 'null' on a "read".<br />
<br />
'''Type Dependent Properties'''<br />
{{TableStart|border_size=1<br />
}}{{TableRowN|'''Property'''|'''Digital'''|'''Analog'''|'''Internal'''|'''External'''|'''Generic'''|'''Input'''|'''Output'''|'''IP Alarm'''|'''Alarmable'''|'''Table Ranged'''|'''Loggable'''|'''Alarm Low'''|'''Alarm High'''<br />
}}{{TableRowN| wireless_zone|''' '''|''' '''|''' '''|'''&#x2713;'''|''' '''|''' '''|''' '''|''' '''|''' '''|''' '''|''' '''|''' '''|''' '''<br />
}}{{TableRowN| pulse_zone|'''&#x2713;'''|''' '''|''' '''|''' '''|''' '''|''' '''|''' '''|''' '''|''' '''|''' '''|''' '''|''' '''|''' '''<br />
}}{{TableRowN| runtime_zone|'''&#x2713;'''|''' '''|''' '''|''' '''|''' '''|''' '''|''' '''|''' '''|''' '''|''' '''|''' '''|''' '''|''' '''<br />
}}{{TableRowN| output_zone|''' '''|''' '''|''' '''|''' '''|''' '''|''' '''|'''&#x2713;'''|''' '''|''' '''|''' '''|''' '''|'''&#x2713;'''|''' '''<br />
}}{{TableRowN| alarm_zone|''' '''|''' '''|''' '''|''' '''|''' '''|''' '''|''' '''|''' '''|'''&#x2713;'''|''' '''|''' '''|'''&#x2713;'''|''' '''<br />
}}{{TableRowN| table_zone|''' '''|'''&#x2713;'''|''' '''|''' '''|''' '''|''' '''|''' '''|''' '''|''' '''|'''&#x2713;'''|''' '''|''' '''|''' '''<br />
}}{{TableRowN| loggable_zone|''' '''|''' '''|''' '''|''' '''|''' '''|''' '''|''' '''|''' '''|''' '''|''' '''|'''&#x2713;'''|''' '''|''' '''<br />
}}{{TableRowN| alarm_low|''' '''|'''&#x2713;'''|''' '''|''' '''|''' '''|''' '''|''' '''|''' '''|'''&#x2713;'''|''' '''|''' '''|'''&#x2713;'''|''' '''<br />
}}{{TableRowN| alarm_high|''' '''|'''&#x2713;'''|''' '''|''' '''|''' '''|''' '''|''' '''|''' '''|'''&#x2713;'''|''' '''|''' '''|''' '''|'''&#x2713;'''<br />
}}{{TableRowN| modbus_zone|''' '''|''' '''|''' '''|''' '''|'''&#x2713;'''|''' '''|''' '''|''' '''|''' '''|''' '''|''' '''|''' '''|''' '''<br />
}}{{TableEnd}}<br />
<br />
===Zone States===<br />
{{TableStart|border_size=1<br />
}}{{TableRowN| '''Zone State'''|'''Value''' <br />
}}{{TableRowN| None | 0 <br />
}}{{TableRowN| Alarm | 1 <br />
}}{{TableRowN| OK | 2 <br />
}}{{TableRowN| Pending | 3 <br />
}}{{TableRowN| Open | 4 <br />
}}{{TableRowN| Closed | 5 <br />
}}{{TableRowN| Cycle | 6 <br />
}}{{TableRowN| Low | 7 <br />
}}{{TableRowN| High | 8 <br />
}}{{TableRowN| Off | 9 <br />
}}{{TableRowN| On | 10 <br />
}}{{TableRowN| Return To Normal | 11 <br />
}}{{TableRowN| Route Down | 12 <br />
}}{{TableRowN| Trouble | 13 <br />
}}{{TableRowN| Not Responding | 14 <br />
}}{{TableRowN| Dependency Failure | 15 <br />
}}{{TableRowN| Battery | 16 <br />
}}{{TableRowN| Acknowledged | 17 <br />
}}{{TableRowN| Unacknowledged | 18 <br />
}}{{TableEnd}}<br />
<br />
'''Output Mode Type''' {{TableStart|border_size=1<br />
}}{{TableRowN| '''Child Property''' |'''Type''' | '''Description'''<br />
}}{{TableRowN| name | String | Name<br />
}}{{TableRowN| action | String | Action<br />
}}{{TableRowN| zone_list | Array of Objects | List of zones<br />
}}{{TableRowN| type_list | Array of Objects | List of Zone type<br />
}}{{TableRowN| trigger | String | Trigger<br />
}}{{TableRowN| compare_on | String | Compare On<br />
}}{{TableRowN| compare_off | String | Compare Off<br />
}}{{TableRowN| limit_on | Float | Limit On<br />
}}{{TableRowN| limit_off | Float | Limit Off<br />
}}{{TableRowN| zone_on | String | Zone On<br />
}}{{TableRowN| zone_off | String | Zone Off<br />
}}{{TableEnd}}<br />
<br />
=== GET ===<br />
<br />
An error will be issued if attempting to receive a Zone property that does not correspond to the Zone type.<br />
<br />
'''URI Mode Request URI's:'''<br />
<br />
*Retrieve all information for every one of a device's zones. <br />
<br />
'''GET''' <nowiki>https://</nowiki>rest.sensaphone.net/api/v1/{ACCTID}/{SESSIONID}/device/{DEVICE_ID}/zone<br />
<br />
*Retrieve all information for a single zone. <br />
<br />
'''GET''' <nowiki>https://</nowiki>rest.sensaphone.net/api/v1/{ACCTID}/{SESSIONID}/device/{DEVICE_ID}/zone/{ZONE_ID}<br />
<br />
*Retrieve the a specific zone's type. <br />
<br />
'''GET''' <nowiki>https://</nowiki>rest.sensaphone.net/api/v1/{ACCTID}/{SESSIONID}/device/{DEVICE_ID}/zone/{ZONE_ID}/type<br />
<br />
'''JSON Mode Request URI:'''<br />
<br />
'''POST''' <nowiki>https://</nowiki>rest.sensaphone.net/api/v1/device/zone<br />
<br />
'''JSON Mode Request Properties''' {{TableStart|border_size=1<br />
}}{{TableRowN| '''Parent Property'''|'''Child Property''' |'''Type''' | '''Description'''<br />
}}{{TableRowN| &nbsp; | acctid | Integer | Account ID<br />
}}{{TableRowN| &nbsp; | session | Integer | Session ID<br />
}}{{TableRowN| &nbsp; | request_type | String | "read"<br />
}}{{TableRowN| &nbsp; | device | Array of Objects | The parent device of the "zone" resource. See [[Sensaphone.net_API/device|device]].<br />
}}{{TableRowN| device | zone | Array of Objects | The zone object<br />
}}{{TableEnd}}<br />
<br />
'''JSON Mode Response Properties''' {{TableStart|border_size=1<br />
}}{{TableRowN| '''Parent Property''' |'''Child Property'''|'''Status'''| '''Type''' | '''Description'''<br />
}}{{TableRowN| &nbsp; | device | Required | Array of Objects | The parent device object.<br />
}}{{TableRowN| device | zone | Required | Array of Objects | The zone object.<br />
}}{{TableRowN| zone | zone_id | Required | Integer | ID of the zone.<br />
}}{{TableRowN| zone | index_id | Optional | Integer | Zone ordering.<br />
}}{{TableRowN| zone | name | Optional | String | Name of the zone.<br />
}}{{TableRowN| zone | canonical_name | Optional | String | Canonical name of the zone.<br />
}}{{TableRowN| zone | type | Optional | String | The zone type. (Use a V2 [[Sensaphone.net_API/zone#GET|read command]] to retrieve the valid values)<br />
}}{{TableRowN| type | type_list | Optional | Array of Objects | The zone type metadata.<br />
}}{{TableRowN| type_list | name | Optional | Boolean | Zone Type Metadata: Name corresponds to the ranged values for the zone type.<br />
}}{{TableRowN| type_list | is_digital | Optional | Boolean | Zone Type Metadata: Digital<br />
}}{{TableRowN| type_list | is_analog | Optional | Boolean | Zone Type Metadata: Analog<br />
}}{{TableRowN| type_list | is_internal | Optional | Boolean | Zone Type Metadata: Internal<br />
}}{{TableRowN| type_list | is_external | Optional | Boolean | Zone Type Metadata: External<br />
}}{{TableRowN| type_list | is_generic | Optional | Boolean | Zone Type Metadata: Generic<br />
}}{{TableRowN| type_list | is_input | Optional | Boolean | Zone Type Metadata: Input<br />
}}{{TableRowN| type_list | is_output | Optional | Boolean | Zone Type Metadata: Output<br />
}}{{TableRowN| type_list | is_ipalarm | Optional | Boolean | Zone Type Metadata: IP Alarm<br />
}}{{TableRowN| type_list | is_alarmable | Optional | Boolean | Zone Type Metadata: Alarmable<br />
}}{{TableRowN| type_list | is_tablerange | Optional | Boolean | Zone Type Metadata: Table Ranged<br />
}}{{TableRowN| type_list | is_loggable | Optional | Boolean | Zone Type Metadata: Loggable<br />
}}{{TableRowN| type_list | is_alarm_low | Optional | Boolean | Zone Type Metadata: Alarm Low<br />
}}{{TableRowN| type_list | is_alarm_high | Optional | Boolean | Zone Type Metadata: Alarm High<br />
}}{{TableRowN| type_list | units_list | Optional | Array of Ranges | Zone Type Metadata: Possible Units<br />
}}{{TableRowN| zone | enable | Optional | Boolean | Whether or not the zone is enabled.<br />
}}{{TableRowN| zone | value | Optional | String | The data value for the zone.<br />
}}{{TableRowN| zone | units | Optional | String | The custom units for the zone.<br />
}}{{TableRowN| zone | schedule | Optional | Object | (See [[Sensaphone.net API/schedule|Sensaphone.net API/schedule]])<br />
}}{{TableRowN| zone | alarm_zone | Optional | Object | Sub-object containing data for alarmable zones. 'null' if unsupported.<br />
}}{{TableRowN| alarm_zone | alarm_rtn | Optional | Boolean or null | Whether or not a return-to-normal alarm is enabled. 'null' if the feature is not supported.<br />
}}{{TableRowN| alarm_zone | alarm_hold | Optional | Integer | The alarm hold (or clear delay) time.<br />
}}{{TableRowN| alarm_zone | alarm_enable | Optional | Boolean | Whether or not alarming is enabled for this zone.<br />
}}{{TableRowN| alarm_zone | rec_time | Optional | Integer | The alarm recognition time.<br />
}}{{TableRowN| alarm_zone | reset_time | Optional | Integer | The alarm reset time.<br />
}}{{TableRowN| alarm_zone | alarm_low | Optional | Floating Point | The alarm low limit.<br />
}}{{TableRowN| alarm_zone | alarm_high | Optional | Floating Point | The alarm high limit.<br />
}}{{TableRowN| alarm_zone | alarm_condition | Optional | Array of ZoneState | The highest priority ZoneState that has been reached<br />
}}{{TableRowN| alarm_zone | alarm_status | Optional | Array of ZoneState | The processed status of the zone ( returns 2 ZoneStates)<br />
}}{{TableRowN| alarm_zone | current_status | Optional | Array of ZoneState | The real-time status of the zone input (returns 1 ZoneState)<br />
}}{{TableRowN| alarm_zone | unack_alarms | Optional | Array of ZoneState | Alarm states that are currently unacknowledged <br />
}}{{TableRowN| alarm_zone | alarmschedule | Optional | Object | (See [[Sensaphone.net API/alarmschedule |Sensaphone.net API/alarmschedule]])<br />
}}{{TableRowN| zone | analog_zone | Optional | Object | Sub-object containing data for analog zones. 'null' if unsupported.<br />
}}{{TableRowN| analog_zone | minimum | Optional | Floating Point | The minimum "value" seen.<br />
}}{{TableRowN| analog_zone | maximum | Optional | Floating Point | The maximum "value" seen.<br />
}}{{TableRowN| analog_zone | calibration | Optional | Floating Point | The calibration factor applied to the "value".<br />
}}{{TableRowN| zone | table_zone | Optional | Object | Sub-object containing data for table-based zones. 'null' if unsupported.<br />
}}{{TableRowN| table_zone | table_low | Optional | Floating Point | The low table range for the zone. Used for 4-20mA sensors.<br />
}}{{TableRowN| table_zone | table_high | Optional | Floating Point | The high table range for the zone. Used for 4-20mA sensors.<br />
}}{{TableRowN| zone | log_zone | Optional | Object | Sub-object containing data for loggable zones. 'null' if unsupported.<br />
}}{{TableRowN| log_zone | report_mode | Optional | String | The reporting option.<br />
}}{{TableRowN| log_zone | alarm_interval | Optional | Integer | The datalogging interval for when in alarm.<br />
}}{{TableRowN| log_zone | normal_interval | Optional | Integer | The datalogging interval for when not in alarm.<br />
}}{{TableRowN| log_zone | enable | Optional | Boolean | Whether or not datalogging is enabled.<br />
}}{{TableRowN| zone | pulse_zone | Optional | Object | Sub-object containing data for pulse count capable zones. 'null' if unsupported.<br />
}}{{TableRowN| pulse_zone | enable | Optional | Boolean | Whether or not pulse counting is enabled for this zone.<br />
}}{{TableRowN| pulse_zone | multiply | Optional | Integer | The multiplication factor to apply to each pulse.<br />
}}{{TableRowN| pulse_zone | count | Optional | Integer | The number of pulses seen (after multiply has been applied)<br />
}}{{TableRowN| zone | runtime_zone | Optional | Object | Sub-object containing data for runtime capable zones. 'null' if unsupported.<br />
}}{{TableRowN| runtime_zone | enable | Optional | Boolean | Whether or not runtime is enabled for this zone.<br />
}}{{TableRowN| runtime_zone | runtime | Optional | String | The run time elapsed.<br />
}}{{TableRowN| zone | modbus_zone | Optional | Object | Sub-object containing data for modbus zones. 'null' if unsupported.<br />
}}{{TableRowN| modbus_zone | media_port | Optional | String | The modbus media port<br />
}}{{TableRowN| modbus_zone | slave_id | Optional | Integer | The modbus slave ID<br />
}}{{TableRowN| modbus_zone | command | Optional | String | The modbus command<br />
}}{{TableRowN| modbus_zone | address | Optional | Integer | The modbus address<br />
}}{{TableRowN| modbus_zone | byte_order | Optional | String | The modbus byte order<br />
}}{{TableRowN| modbus_zone | register_order | Optional | String | The modbus register order<br />
}}{{TableRowN| modbus_zone | register_size | Optional | String | The modbus register size<br />
}}{{TableRowN| modbus_zone | format | Optional | String | The modbus format<br />
}}{{TableRowN| modbus_zone | sign | Optional | String | The modbus sign<br />
}}{{TableRowN| modbus_zone | scaling_offset | Optional | Integer | The modbus scaling offset<br />
}}{{TableRowN| modbus_zone | scaling_factor | Optional | Integer | The modbus scaling factor<br />
}}{{TableRowN| modbus_zone | scaling_mode | Optional | String | The modbus scaling mode<br />
}}{{TableRowN| zone | output_zone | Optional | Object | Sub-object containing data for output zones. 'null' if unsupported.<br />
}}{{TableRowN| output_zone | mode | Optional | Output Mode Type | The output mode<br />
}}{{TableRowN| output_zone | mode_list | Optional | Array of Output Mode Type | The list of output modes<br />
}}{{TableRowN| output_zone | set_point_on | Optional | Floating Point | The output set point for the "on" state.<br />
}}{{TableRowN| output_zone | set_point_off | Optional | Floating Point | The output set point for the "off" state.<br />
}}{{TableRowN| zone | wireless_zone | Optional | Object | Sub-object containing data for wireless zones. 'null' if unsupported.<br />
}}{{TableRowN| wireless_zone | sampling_rate | Optional | Integer | The sampling rate for the sensor<br />
}}{{TableRowN| wireless_zone | serial_number | Optional | Integer | The serial number for the wireless sensor.<br />
}}{{TableRowN| wireless_zone | battery_level | Optional | String | The wireless sensor's battery level.<br />
}}{{TableRowN| wireless_zone | power_level | Optional | String | The wireless sensor's power level.<br />
}}{{TableEnd}}<br />
<br />
==== Example JSON ====<br />
<br />
Receive the status for a specific Zone.<br />
<br />
*'''Request JSON''' <br />
<br />
{<br />
"acctid": 987654,<br />
"uuid": "0123-4567-8901",<br />
"request_type": "read",<br />
"device":[<br />
{<br />
"device_id": 1234,<br />
"zone":[<br />
{<br />
"zone_id":28487,<br />
"status": "null"<br />
}<br />
]<br />
}<br />
]<br />
}<br />
<br />
*'''Response JSON''' <br />
<br />
{<br />
"result":<br />
{<br />
"success": true,<br />
"code": 0,<br />
"message": "OK"<br />
},<br />
"response":<br />
{<br />
"device":[<br />
{<br />
"device_id": 1234,<br />
"zone":[<br />
{<br />
"zone_id": 28487,<br />
"status": "OK"<br />
}<br />
]<br />
}<br />
]<br />
}<br />
}<br />
<br />
===PUT===<br />
'''URI Mode Request URI's:'''<br />
*Edit a Zone name <br />
'''PUT''' <nowiki>https://</nowiki>rest.sensaphone.net/api/v1/{ACCTID}/{SESSIONID}/device/{DEVICE_ID}/zone/{ZONE_ID}/name/{ZONE_NAME}<br />
*Edit a Zone's recognition time value <br />
'''PUT''' <nowiki>https://</nowiki>rest.sensaphone.net/api/v1/{ACCTID}/{SESSIONID}/device/{DEVICE_ID}/zone/{ZONE_ID}/alarm_zone/rec_time/{REC_TIME}<br />
<br />
'''JSON Mode Request URI:'''<br />
'''POST''' <nowiki>https://</nowiki>rest.sensaphone.net/api/v1/device/zone<br />
<br />
'''JSON Mode Request Properties'''<br />
{{TableStart|border_size=1<br />
}}{{TableRowN| '''Parent Property'''|'''Child Property''' |'''Type''' | '''Description'''<br />
}}{{TableRowN| &nbsp; | acctid | Integer | Account ID<br />
}}{{TableRowN| &nbsp; | session | Integer | Session ID<br />
}}{{TableRowN| &nbsp; | request_type | String | "read"<br />
}}{{TableRowN| &nbsp; | device | Array of Objects | The parent device of the "zone" resource. See [[Sensaphone.net_API/device|device]].<br />
}}{{TableRowN| device | zone | Array of Objects | The zone object.<br />
}}{{TableRowN| zone | zone_id | Integer | ID of the zone.<br />
}}{{TableRowN| zone | '''''CHILD PROPERTY''''' | &nbsp; | Zone's child properties to be edited*<br />
}}{{TableEnd}}<br />
<nowiki>*</nowiki> One or more '''zone''' child properties listed below are required in addition to "zone_id".<br />
<br />
'''JSON Mode Response Properties'''<br />
{{TableStart|border_size=1<br />
}}{{TableRowN| '''Parent Property''' |'''Child Property'''|'''Status'''| '''Type''' | '''Description'''<br />
}}{{TableRowN| &nbsp; | device | Required | Array of Objects | The parent device object.<br />
}}{{TableRowN| device | zone | Required | Array of Objects | The zone object.<br />
}}{{TableRowN| zone | zone_id | Required | Integer | ID of the zone.<br />
}}{{TableRowN| zone | index_id | Optional | Integer | Zone ordering.<br />
}}{{TableRowN| zone | name | Optional | String | Name of the zone.<br />
}}{{TableRowN| zone | type | Optional | String | The zone type. (Use a V2 [[Sensaphone.net_API/zone#GET|read command]] to retrieve the valid values)<br />
}}{{TableRowN| zone | enable | Optional | Boolean | Whether or not the zone is enabled.<br />
}}{{TableRowN| zone | value | Optional | String | The data value for the zone.<br />
}}{{TableRowN| zone | units | Optional | String | The custom units for the zone.<br />
}}{{TableRowN| zone | schedule | Optional | Object | (See [[Sensaphone.net API/schedule|Sensaphone.net API/schedule]])<br />
}}{{TableRowN| zone | alarm_zone | Optional | Object | Sub-object containing data for alarmable zones. 'null' if unsupported.<br />
}}{{TableRowN| alarm_zone | alarm_rtn | Optional | Boolean or null | Whether or not a return-to-normal alarm is enabled. 'null' if the feature is not supported.<br />
}}{{TableRowN| alarm_zone | alarm_hold | Optional | Integer | The alarm hold (or clear delay) time.<br />
}}{{TableRowN| alarm_zone | alarm_enable | Optional | Boolean | Whether or not alarming is enabled for this zone.<br />
}}{{TableRowN| alarm_zone | rec_time | Optional | Integer | The alarm recognition time.<br />
}}{{TableRowN| alarm_zone | reset_time | Optional | Integer | The alarm reset time.<br />
}}{{TableRowN| alarm_zone | alarm_low | Optional | Floating Point | The alarm low limit.<br />
}}{{TableRowN| alarm_zone | alarm_high | Optional | Floating Point | The alarm high limit.<br />
}}{{TableRowN| alarm_zone | alarmschedule | Optional | Object | (See [[Sensaphone.net API/alarmschedule |Sensaphone.net API/alarmschedule]])<br />
}}{{TableRowN| zone | analog_zone | Optional | Object | Sub-object containing data for analog zones. 'null' if unsupported.<br />
}}{{TableRowN| analog_zone | minimum | Optional | Boolean | Clear the minimum value.<br />
}}{{TableRowN| analog_zone | maximum | Optional | Boolean | Clear the maximum value.<br />
}}{{TableRowN| analog_zone | calibration | Optional | Floating Point | The calibration factor applied to the "value".<br />
}}{{TableRowN| zone | table_zone | Optional | Object | Sub-object containing data for table-based zones. 'null' if unsupported.<br />
}}{{TableRowN| table_zone | table_low | Optional | Floating Point | The low table range for the zone. Used for 4-20mA sensors.<br />
}}{{TableRowN| table_zone | table_high | Optional | Floating Point | The high table range for the zone. Used for 4-20mA sensors.<br />
}}{{TableRowN| zone | log_zone | Optional | Object | Sub-object containing data for loggable zones. 'null' if unsupported.<br />
}}{{TableRowN| log_zone | report_mode | Optional | String | The reporting option.<br />
}}{{TableRowN| log_zone | alarm_interval | Optional | Integer | The datalogging interval for when in alarm.<br />
}}{{TableRowN| log_zone | normal_interval | Optional | Integer | The datalogging interval for when not in alarm.<br />
}}{{TableRowN| log_zone | enable | Optional | Boolean | Whether or not datalogging is enabled.<br />
}}{{TableRowN| zone | pulse_zone | Optional | Object | Sub-object containing data for pulse count capable zones. 'null' if unsupported.<br />
}}{{TableRowN| pulse_zone | enable | Optional | Boolean | Whether or not pulse counting is enabled for this zone.<br />
}}{{TableRowN| pulse_zone | multiply | Optional | Integer | The multiplication factor to apply to each pulse.<br />
}}{{TableRowN| pulse_zone | count | Optional | Integer | The number of pulses seen (after multiply has been applied)<br />
}}{{TableRowN| zone | runtime_zone | Optional | Object | Sub-object containing data for runtime capable zones. 'null' if unsupported.<br />
}}{{TableRowN| runtime_zone | enable | Optional | Boolean | Whether or not runtime is enabled for this zone.<br />
}}{{TableRowN| runtime_zone | runtime | Optional | String | The run time elapsed.<br />
}}{{TableRowN| zone | modbus_zone | Optional | Object | Sub-object containing data for modbus zones. 'null' if unsupported.<br />
}}{{TableRowN| modbus_zone | media_port | Optional | String | The modbus media port<br />
}}{{TableRowN| modbus_zone | slave_id | Optional | Integer | The modbus slave ID<br />
}}{{TableRowN| modbus_zone | command | Optional | String | The modbus command<br />
}}{{TableRowN| modbus_zone | address | Optional | Integer | The modbus address<br />
}}{{TableRowN| modbus_zone | byte_order | Optional | String | The modbus byte order<br />
}}{{TableRowN| modbus_zone | register_order | Optional | String | The modbus register order<br />
}}{{TableRowN| modbus_zone | register_size | Optional | String | The modbus register size<br />
}}{{TableRowN| modbus_zone | format | Optional | String | The modbus format<br />
}}{{TableRowN| modbus_zone | sign | Optional | String | The modbus sign<br />
}}{{TableRowN| modbus_zone | scaling_offset | Optional | Integer | The modbus scaling offset<br />
}}{{TableRowN| modbus_zone | scaling_factor | Optional | Integer | The modbus scaling factor<br />
}}{{TableRowN| modbus_zone | scaling_mode | Optional | String | The modbus scaling mode<br />
}}{{TableRowN| zone | output_zone | Optional | Object | Sub-object containing data for output zones. 'null' if unsupported.<br />
}}{{TableRowN| output_zone | mode | Optional | String | The output mode<br />
}}{{TableRowN| output_zone | mode_list | Optional | String | The list of output modes<br />
}}{{TableRowN| output_zone | set_point_on | Optional | Floating Point | The output set point for the "on" state.<br />
}}{{TableRowN| output_zone | set_point_off | Optional | Floating Point | The output set point for the "off" state.<br />
}}{{TableRowN| output_zone | value | Optional | Floating Point | *Write Only* set the value of the output zone<br />
}}{{TableRowN| zone | wireless_zone | Optional | Object | Sub-object containing data for wireless zones. 'null' if unsupported.<br />
}}{{TableRowN| wireless_zone | sampling_rate | Optional | Integer | The sampling rate for the sensor<br />
}}{{TableRowN| wireless_zone | serial_number | Optional | Integer | The serial number for the wireless sensor.<br />
}}{{TableEnd}}<br />
<br />
===POST===<br />
'''URI Mode Request URI's:'''<br />
*Acknowledge All Zone Alarms<br />
'''POST''' <nowiki>https://</nowiki>rest.sensaphone.net/api/v1/{ACCTID}/{SESSIONID}/device/{DEVICE_ID}/zone/{ZONE_ID}/alarm_zone/acknowledge_all_alarms/{true}<br />
<br />
'''JSON Mode Request URI:'''<br />
'''POST''' <nowiki>https://</nowiki>rest.sensaphone.net/api/v1/device/zone<br />
<br />
'''JSON Mode Request Properties'''<br />
{{TableStart|border_size=1<br />
}}{{TableRowN| '''Parent Property'''|'''Child Property''' |'''Type''' | '''Description'''<br />
}}{{TableRowN| &nbsp; | acctid | Integer | Account ID<br />
}}{{TableRowN| &nbsp; | session | Integer | Session ID<br />
}}{{TableRowN| &nbsp; | request_type | String | "read"<br />
}}{{TableRowN| &nbsp; | device | Array of Objects | The parent device of the "zone" resource. See [[Sensaphone.net_API/device|device]].<br />
}}{{TableRowN| device | zone | Array of Objects | The zone object.<br />
}}{{TableRowN| zone | zone_id | Integer | ID of the zone.<br />
}}{{TableRowN| zone | alarm_zone | Object | Sub-object containing data for alarmable zones<br />
}}{{TableRowN| alarm_zone | acknowledge_alarms | Array of Zone State | A write-only property to acknowledge specific alarms<br />
}}{{TableRowN| alarm_zone | acknowledge_all_alarms | Boolean | A write-only property to acknowledge all alarms for a zone<br />
}}{{TableEnd}}<br />
<nowiki>*</nowiki> "acknowledge_all_alarms" supersedes "acknowledge_alarms", if it is present in the request json other properties will be ignored<br />
<br />
'''JSON Mode Result Properties'''<br />
{{TableStart|border_size=1<br />
}}{{TableRowN| '''Parent Property''' |'''Child Property'''|'''Status'''| '''Type''' | '''Description'''<br />
}}{{TableRowN| &nbsp; | device | Required | Array of Objects | The parent device object.<br />
}}{{TableRowN| device | zone | Required | Array of Objects | The zone object.<br />
}}{{TableRowN| zone | zone_id | Required | Integer | ID of the zone.<br />
}}{{TableRowN| zone | alarm_zone | Required | Object | Sub-object containing data for alarmable zones. 'null' if unsupported.<br />
}}{{TableRowN| alarm_zone | acknowledge_alarms | Optional | Array of Zone State | A write-only property to acknowledge specific alarms<br />
}}{{TableRowN| alarm_zone | acknowledge_all_alarms | Optional | Boolean | A write-only property to acknowledge all alarms for a zone<br />
}}{{TableEnd}}<br />
<br />
=== Example JSON ===<br />
<br />
Acknowledge an alarm for a Zone<br />
<br />
*'''Request JSON''' <br />
<br />
{<br />
"request_type": "create",<br />
"resource": "device",<br />
"acctid": 987654,<br />
"session": "0123-4567-8901",<br />
"device": [<br />
{<br />
"device_id": 1234,<br />
"zone": [<br />
{<br />
"zone_id": 7,<br />
"alarm_zone": {<br />
"acknowledge_alarms": [<br />
11,<br />
4<br />
]<br />
}<br />
}<br />
]<br />
}<br />
]<br />
}<br />
<br />
*'''Response JSON''' <br />
<br />
{<br />
"result": {<br />
"success": true,<br />
"code": 0,<br />
"message": "OK",<br />
"properties": {<br />
"device": [<br />
{<br />
"device_id": 1234,<br />
"zone": [<br />
{<br />
"alarm_zone": [<br />
{<br />
"acknowledge_alarms": 11,<br />
"code": 0,<br />
"message": "OK",<br />
"success": true<br />
},<br />
{<br />
"acknowledge_alarms": 4,<br />
"code": 0,<br />
"message": "OK",<br />
"success": true<br />
}<br />
],<br />
"zone_id": 7<br />
}<br />
]<br />
}<br />
]<br />
}<br />
}<br />
}</div>
Derek
https://wiki.sensaphone.net/index.php?title=Sensaphone.net_API/zone&diff=164
Sensaphone.net API/zone
2017-02-21T15:43:42Z
<p>Derek: </p>
<hr />
<div>=[[Sensaphone.net API]]=<br />
<br />
==Specifications==<br />
Different zones types may have different configurable properties than others. For example, a '''''2.8k Thermistor F''''' type Zone will have '''''calibration''''', '''''alarm low''''', and '''''alarm high''''' but a '''''Normally Open''''' type zone will not. If a request is made for a property not belonging to a zone type an error will be issued. Below is a chart showing the relations. A property is only available if the type metadata (The '''type_list''' property) has the checked options enabled. Whether or not the above properties correspond with a particular zone type is defined in the meta data for the zone types '''(included in v2 but not v1 of the API)'''. In addition, a property may be disabled at the global scale if it is 'null', regardless of this table. For example, the zone type's meta indicates that it is "External" but the "wireless_zone" field is 'null' on a "read".<br />
<br />
'''Type Dependent Properties'''<br />
{{TableStart|border_size=1<br />
}}{{TableRowN|'''Property'''|'''Digital'''|'''Analog'''|'''Internal'''|'''External'''|'''Generic'''|'''Input'''|'''Output'''|'''IP Alarm'''|'''Alarmable'''|'''Table Ranged'''|'''Loggable'''|'''Alarm Low'''|'''Alarm High'''<br />
}}{{TableRowN| wireless_zone|''' '''|''' '''|''' '''|'''&#x2713;'''|''' '''|''' '''|''' '''|''' '''|''' '''|''' '''|''' '''|''' '''|''' '''<br />
}}{{TableRowN| pulse_zone|'''&#x2713;'''|''' '''|''' '''|''' '''|''' '''|''' '''|''' '''|''' '''|''' '''|''' '''|''' '''|''' '''|''' '''<br />
}}{{TableRowN| runtime_zone|'''&#x2713;'''|''' '''|''' '''|''' '''|''' '''|''' '''|''' '''|''' '''|''' '''|''' '''|''' '''|''' '''|''' '''<br />
}}{{TableRowN| output_zone|''' '''|''' '''|''' '''|''' '''|''' '''|''' '''|'''&#x2713;'''|''' '''|''' '''|''' '''|''' '''|'''&#x2713;'''|''' '''<br />
}}{{TableRowN| alarm_zone|''' '''|''' '''|''' '''|''' '''|''' '''|''' '''|''' '''|''' '''|'''&#x2713;'''|''' '''|''' '''|'''&#x2713;'''|''' '''<br />
}}{{TableRowN| table_zone|''' '''|'''&#x2713;'''|''' '''|''' '''|''' '''|''' '''|''' '''|''' '''|''' '''|'''&#x2713;'''|''' '''|''' '''|''' '''<br />
}}{{TableRowN| loggable_zone|''' '''|''' '''|''' '''|''' '''|''' '''|''' '''|''' '''|''' '''|''' '''|''' '''|'''&#x2713;'''|''' '''|''' '''<br />
}}{{TableRowN| alarm_low|''' '''|'''&#x2713;'''|''' '''|''' '''|''' '''|''' '''|''' '''|''' '''|'''&#x2713;'''|''' '''|''' '''|'''&#x2713;'''|''' '''<br />
}}{{TableRowN| alarm_high|''' '''|'''&#x2713;'''|''' '''|''' '''|''' '''|''' '''|''' '''|''' '''|'''&#x2713;'''|''' '''|''' '''|''' '''|'''&#x2713;'''<br />
}}{{TableRowN| modbus_zone|''' '''|''' '''|''' '''|''' '''|'''&#x2713;'''|''' '''|''' '''|''' '''|''' '''|''' '''|''' '''|''' '''|''' '''<br />
}}{{TableEnd}}<br />
<br />
===Zone States===<br />
{{TableStart|border_size=1<br />
}}{{TableRowN| '''Zone State'''|'''Value''' <br />
}}{{TableRowN| None | 0 <br />
}}{{TableRowN| Alarm | 1 <br />
}}{{TableRowN| OK | 2 <br />
}}{{TableRowN| Pending | 3 <br />
}}{{TableRowN| Open | 4 <br />
}}{{TableRowN| Closed | 5 <br />
}}{{TableRowN| Cycle | 6 <br />
}}{{TableRowN| Low | 7 <br />
}}{{TableRowN| High | 8 <br />
}}{{TableRowN| Off | 9 <br />
}}{{TableRowN| On | 10 <br />
}}{{TableRowN| Return To Normal | 11 <br />
}}{{TableRowN| Route Down | 12 <br />
}}{{TableRowN| Trouble | 13 <br />
}}{{TableRowN| Not Responding | 14 <br />
}}{{TableRowN| Dependency Failure | 15 <br />
}}{{TableRowN| Battery | 16 <br />
}}{{TableRowN| Acknowledged | 17 <br />
}}{{TableRowN| Unacknowledged | 18 <br />
}}{{TableEnd}}<br />
<br />
'''Output Mode Type''' {{TableStart|border_size=1<br />
}}{{TableRowN| '''Child Property''' |'''Type''' | '''Description'''<br />
}}{{TableRowN| name | String | Name<br />
}}{{TableRowN| action | String | Action<br />
}}{{TableRowN| zone_list | Array of Objects | List of zones<br />
}}{{TableRowN| type_list | Array of Objects | List of Zone type<br />
}}{{TableRowN| trigger | String | Trigger<br />
}}{{TableRowN| compare_on | String | Compare On<br />
}}{{TableRowN| compare_off | String | Compare Off<br />
}}{{TableRowN| limit_on | Float | Limit On<br />
}}{{TableRowN| limit_off | Float | Limit Off<br />
}}{{TableRowN| zone_on | String | Zone On<br />
}}{{TableRowN| zone_off | String | Zone Off<br />
}}{{TableEnd}}<br />
<br />
=== GET ===<br />
<br />
An error will be issued if attempting to receive a Zone property that does not correspond to the Zone type.<br />
<br />
'''URI Mode Request URI's:'''<br />
<br />
*Retrieve all information for every one of a device's zones. <br />
<br />
'''GET''' <nowiki>https://</nowiki>rest.sensaphone.net/api/v1/{ACCTID}/{SESSIONID}/device/{DEVICE_ID}/zone<br />
<br />
*Retrieve all information for a single zone. <br />
<br />
'''GET''' <nowiki>https://</nowiki>rest.sensaphone.net/api/v1/{ACCTID}/{SESSIONID}/device/{DEVICE_ID}/zone/{ZONE_ID}<br />
<br />
*Retrieve the a specific zone's type. <br />
<br />
'''GET''' <nowiki>https://</nowiki>rest.sensaphone.net/api/v1/{ACCTID}/{SESSIONID}/device/{DEVICE_ID}/zone/{ZONE_ID}/type<br />
<br />
'''JSON Mode Request URI:'''<br />
<br />
'''POST''' <nowiki>https://</nowiki>rest.sensaphone.net/api/v1/device/zone<br />
<br />
'''JSON Mode Request Properties''' {{TableStart|border_size=1<br />
}}{{TableRowN| '''Parent Property'''|'''Child Property''' |'''Type''' | '''Description'''<br />
}}{{TableRowN| &nbsp; | acctid | Integer | Account ID<br />
}}{{TableRowN| &nbsp; | session | Integer | Session ID<br />
}}{{TableRowN| &nbsp; | request_type | String | "read"<br />
}}{{TableRowN| &nbsp; | device | Array of Objects | The parent device of the "zone" resource. See [[Sensaphone.net_API/device|device]].<br />
}}{{TableRowN| device | zone | Array of Objects | The zone object<br />
}}{{TableEnd}}<br />
<br />
'''JSON Mode Response Properties''' {{TableStart|border_size=1<br />
}}{{TableRowN| '''Parent Property''' |'''Child Property'''|'''Status'''| '''Type''' | '''Description'''<br />
}}{{TableRowN| &nbsp; | device | Required | Array of Objects | The parent device object.<br />
}}{{TableRowN| device | zone | Required | Array of Objects | The zone object.<br />
}}{{TableRowN| zone | zone_id | Required | Integer | ID of the zone.<br />
}}{{TableRowN| zone | index_id | Optional | Integer | Zone ordering.<br />
}}{{TableRowN| zone | name | Optional | String | Name of the zone.<br />
}}{{TableRowN| zone | canonical_name | Optional | String | Canonical name of the zone.<br />
}}{{TableRowN| zone | type | Optional | String | The zone type. (Use a V2 [[Sensaphone.net_API/zone#GET|read command]] to retrieve the valid values)<br />
}}{{TableRowN| type | type_list | Optional | Array of Objects | The zone type metadata.<br />
}}{{TableRowN| type_list | name | Optional | Boolean | Zone Type Metadata: Name corresponds to the ranged values for the zone type.<br />
}}{{TableRowN| type_list | is_digital | Optional | Boolean | Zone Type Metadata: Digital<br />
}}{{TableRowN| type_list | is_analog | Optional | Boolean | Zone Type Metadata: Analog<br />
}}{{TableRowN| type_list | is_internal | Optional | Boolean | Zone Type Metadata: Internal<br />
}}{{TableRowN| type_list | is_external | Optional | Boolean | Zone Type Metadata: External<br />
}}{{TableRowN| type_list | is_generic | Optional | Boolean | Zone Type Metadata: Generic<br />
}}{{TableRowN| type_list | is_input | Optional | Boolean | Zone Type Metadata: Input<br />
}}{{TableRowN| type_list | is_output | Optional | Boolean | Zone Type Metadata: Output<br />
}}{{TableRowN| type_list | is_ipalarm | Optional | Boolean | Zone Type Metadata: IP Alarm<br />
}}{{TableRowN| type_list | is_alarmable | Optional | Boolean | Zone Type Metadata: Alarmable<br />
}}{{TableRowN| type_list | is_tablerange | Optional | Boolean | Zone Type Metadata: Table Ranged<br />
}}{{TableRowN| type_list | is_loggable | Optional | Boolean | Zone Type Metadata: Loggable<br />
}}{{TableRowN| type_list | is_alarm_low | Optional | Boolean | Zone Type Metadata: Alarm Low<br />
}}{{TableRowN| type_list | is_alarm_high | Optional | Boolean | Zone Type Metadata: Alarm High<br />
}}{{TableRowN| type_list | units_list | Optional | Array of Ranges | Zone Type Metadata: Possible Units<br />
}}{{TableRowN| zone | enable | Optional | Boolean | Whether or not the zone is enabled.<br />
}}{{TableRowN| zone | value | Optional | String | The data value for the zone.<br />
}}{{TableRowN| zone | units | Optional | String | The custom units for the zone.<br />
}}{{TableRowN| zone | schedule | Optional | Object | (See [[Sensaphone.net API/schedule|Sensaphone.net API/schedule]])<br />
}}{{TableRowN| zone | alarm_zone | Optional | Object | Sub-object containing data for alarmable zones. 'null' if unsupported.<br />
}}{{TableRowN| alarm_zone | alarm_rtn | Optional | Boolean or null | Whether or not a return-to-normal alarm is enabled. 'null' if the feature is not supported.<br />
}}{{TableRowN| alarm_zone | alarm_hold | Optional | Integer | The alarm hold (or clear delay) time.<br />
}}{{TableRowN| alarm_zone | alarm_enable | Optional | Boolean | Whether or not alarming is enabled for this zone.<br />
}}{{TableRowN| alarm_zone | rec_time | Optional | Integer | The alarm recognition time.<br />
}}{{TableRowN| alarm_zone | reset_time | Optional | Integer | The alarm reset time.<br />
}}{{TableRowN| alarm_zone | alarm_low | Optional | Floating Point | The alarm low limit.<br />
}}{{TableRowN| alarm_zone | alarm_high | Optional | Floating Point | The alarm high limit.<br />
}}{{TableRowN| alarm_zone | alarm_condition | Optional | Array of ZoneState | The highest priority ZoneState that has been reached<br />
}}{{TableRowN| alarm_zone | alarm_status | Optional | Array of ZoneState | The processed status of the zone ( returns 2 ZoneStates)<br />
}}{{TableRowN| alarm_zone | current_status | Optional | Array of ZoneState | The real-time status of the zone input (returns 1 ZoneState)<br />
}}{{TableRowN| alarm_zone | unack_alarms | Optional | Array of ZoneState | Alarm states that are currently unacknowledged <br />
}}{{TableRowN| alarm_zone | alarmschedule | Optional | Object | (See [[Sensaphone.net API/alarmschedule |Sensaphone.net API/alarmschedule]])<br />
}}{{TableRowN| zone | analog_zone | Optional | Object | Sub-object containing data for analog zones. 'null' if unsupported.<br />
}}{{TableRowN| analog_zone | minimum | Optional | Floating Point | The minimum "value" seen.<br />
}}{{TableRowN| analog_zone | maximum | Optional | Floating Point | The maximum "value" seen.<br />
}}{{TableRowN| analog_zone | calibration | Optional | Floating Point | The calibration factor applied to the "value".<br />
}}{{TableRowN| zone | table_zone | Optional | Object | Sub-object containing data for table-based zones. 'null' if unsupported.<br />
}}{{TableRowN| table_zone | table_low | Optional | Floating Point | The low table range for the zone. Used for 4-20mA sensors.<br />
}}{{TableRowN| table_zone | table_high | Optional | Floating Point | The high table range for the zone. Used for 4-20mA sensors.<br />
}}{{TableRowN| zone | log_zone | Optional | Object | Sub-object containing data for loggable zones. 'null' if unsupported.<br />
}}{{TableRowN| log_zone | report_mode | Optional | String | The reporting option.<br />
}}{{TableRowN| log_zone | alarm_interval | Optional | Integer | The datalogging interval for when in alarm.<br />
}}{{TableRowN| log_zone | normal_interval | Optional | Integer | The datalogging interval for when not in alarm.<br />
}}{{TableRowN| log_zone | enable | Optional | Boolean | Whether or not datalogging is enabled.<br />
}}{{TableRowN| zone | pulse_zone | Optional | Object | Sub-object containing data for pulse count capable zones. 'null' if unsupported.<br />
}}{{TableRowN| pulse_zone | enable | Optional | Boolean | Whether or not pulse counting is enabled for this zone.<br />
}}{{TableRowN| pulse_zone | multiply | Optional | Integer | The multiplication factor to apply to each pulse.<br />
}}{{TableRowN| pulse_zone | count | Optional | Integer | The number of pulses seen (after multiply has been applied)<br />
}}{{TableRowN| zone | runtime_zone | Optional | Object | Sub-object containing data for runtime capable zones. 'null' if unsupported.<br />
}}{{TableRowN| runtime_zone | enable | Optional | Boolean | Whether or not runtime is enabled for this zone.<br />
}}{{TableRowN| runtime_zone | runtime | Optional | String | The run time elapsed.<br />
}}{{TableRowN| zone | modbus_zone | Optional | Object | Sub-object containing data for modbus zones. 'null' if unsupported.<br />
}}{{TableRowN| modbus_zone | media_port | Optional | String | The modbus media port<br />
}}{{TableRowN| modbus_zone | slave_id | Optional | Integer | The modbus slave ID<br />
}}{{TableRowN| modbus_zone | command | Optional | String | The modbus command<br />
}}{{TableRowN| modbus_zone | address | Optional | Integer | The modbus address<br />
}}{{TableRowN| modbus_zone | byte_order | Optional | String | The modbus byte order<br />
}}{{TableRowN| modbus_zone | register_order | Optional | String | The modbus register order<br />
}}{{TableRowN| modbus_zone | register_size | Optional | String | The modbus register size<br />
}}{{TableRowN| modbus_zone | format | Optional | String | The modbus format<br />
}}{{TableRowN| modbus_zone | sign | Optional | String | The modbus sign<br />
}}{{TableRowN| modbus_zone | scaling_offset | Optional | Integer | The modbus scaling offset<br />
}}{{TableRowN| modbus_zone | scaling_factor | Optional | Integer | The modbus scaling factor<br />
}}{{TableRowN| modbus_zone | scaling_mode | Optional | String | The modbus scaling mode<br />
}}{{TableRowN| zone | output_zone | Optional | Object | Sub-object containing data for output zones. 'null' if unsupported.<br />
}}{{TableRowN| output_zone | mode | Optional | Output Mode Type | The output mode<br />
}}{{TableRowN| output_zone | mode_list | Optional | Array of Output Mode Type | The list of output modes<br />
}}{{TableRowN| output_zone | set_point_on | Optional | Floating Point | The output set point for the "on" state.<br />
}}{{TableRowN| output_zone | set_point_off | Optional | Floating Point | The output set point for the "off" state.<br />
}}{{TableRowN| zone | wireless_zone | Optional | Object | Sub-object containing data for wireless zones. 'null' if unsupported.<br />
}}{{TableRowN| wireless_zone | sampling_rate | Optional | Integer | The sampling rate for the sensor<br />
}}{{TableRowN| wireless_zone | serial_number | Optional | Integer | The serial number for the wireless sensor.<br />
}}{{TableRowN| wireless_zone | battery_level | Optional | String | The wireless sensor's battery level.<br />
}}{{TableRowN| wireless_zone | power_level | Optional | String | The wireless sensor's power level.<br />
}}{{TableEnd}}<br />
<br />
==== Example JSON ====<br />
<br />
Receive the status for a specific Zone.<br />
<br />
*'''Request JSON''' <br />
<br />
{<br />
"acctid": 987654,<br />
"uuid": "0123-4567-8901",<br />
"request_type": "read",<br />
"device":[<br />
{<br />
"device_id": 1234,<br />
"zone":[<br />
{<br />
"zone_id":28487,<br />
"status": "null"<br />
}<br />
]<br />
}<br />
]<br />
}<br />
<br />
*'''Response JSON''' <br />
<br />
{<br />
"result":<br />
{<br />
"success": true,<br />
"code": 0,<br />
"message": "OK"<br />
},<br />
"response":<br />
{<br />
"device":[<br />
{<br />
"device_id": 1234,<br />
"zone":[<br />
{<br />
"zone_id": 28487,<br />
"status": "OK"<br />
}<br />
]<br />
}<br />
]<br />
}<br />
}<br />
<br />
===PUT===<br />
'''URI Mode Request URI's:'''<br />
*Edit a Zone name <br />
'''PUT''' <nowiki>https://</nowiki>rest.sensaphone.net/api/v1/{ACCTID}/{SESSIONID}/device/{DEVICE_ID}/zone/{ZONE_ID}/name/{ZONE_NAME}<br />
*Edit a Zone's recognition time value <br />
'''PUT''' <nowiki>https://</nowiki>rest.sensaphone.net/api/v1/{ACCTID}/{SESSIONID}/device/{DEVICE_ID}/zone/{ZONE_ID}/alarm_zone/rec_time/{REC_TIME}<br />
<br />
'''JSON Mode Request URI:'''<br />
'''POST''' <nowiki>https://</nowiki>rest.sensaphone.net/api/v1/device/zone<br />
<br />
'''JSON Mode Request Properties'''<br />
{{TableStart|border_size=1<br />
}}{{TableRowN| '''Parent Property'''|'''Child Property''' |'''Type''' | '''Description'''<br />
}}{{TableRowN| &nbsp; | acctid | Integer | Account ID<br />
}}{{TableRowN| &nbsp; | session | Integer | Session ID<br />
}}{{TableRowN| &nbsp; | request_type | String | "read"<br />
}}{{TableRowN| &nbsp; | device | Array of Objects | The parent device of the "zone" resource. See [[Sensaphone.net_API/device|device]].<br />
}}{{TableRowN| device | zone | Array of Objects | The zone object.<br />
}}{{TableRowN| zone | zone_id | Integer | ID of the zone.<br />
}}{{TableRowN| zone | '''''CHILD PROPERTY''''' | &nbsp; | Zone's child properties to be edited*<br />
}}{{TableEnd}}<br />
<nowiki>*</nowiki> One or more '''zone''' child properties listed below are required in addition to "zone_id".<br />
<br />
'''JSON Mode Response Properties'''<br />
{{TableStart|border_size=1<br />
}}{{TableRowN| '''Parent Property''' |'''Child Property'''|'''Status'''| '''Type''' | '''Description'''<br />
}}{{TableRowN| &nbsp; | device | Required | Array of Objects | The parent device object.<br />
}}{{TableRowN| device | zone | Required | Array of Objects | The zone object.<br />
}}{{TableRowN| zone | zone_id | Required | Integer | ID of the zone.<br />
}}{{TableRowN| zone | index_id | Optional | Integer | Zone ordering.<br />
}}{{TableRowN| zone | name | Optional | String | Name of the zone.<br />
}}{{TableRowN| zone | type | Optional | String | The zone type. (Use a V2 [[Sensaphone.net_API/zone#GET|read command]] to retrieve the valid values)<br />
}}{{TableRowN| zone | enable | Optional | Boolean | Whether or not the zone is enabled.<br />
}}{{TableRowN| zone | value | Optional | String | The data value for the zone.<br />
}}{{TableRowN| zone | units | Optional | String | The custom units for the zone.<br />
}}{{TableRowN| zone | schedule | Optional | Object | (See [[Sensaphone.net API/schedule|Sensaphone.net API/schedule]])<br />
}}{{TableRowN| zone | alarm_zone | Optional | Object | Sub-object containing data for alarmable zones. 'null' if unsupported.<br />
}}{{TableRowN| alarm_zone | alarm_rtn | Optional | Boolean or null | Whether or not a return-to-normal alarm is enabled. 'null' if the feature is not supported.<br />
}}{{TableRowN| alarm_zone | alarm_hold | Optional | Integer | The alarm hold (or clear delay) time.<br />
}}{{TableRowN| alarm_zone | alarm_enable | Optional | Boolean | Whether or not alarming is enabled for this zone.<br />
}}{{TableRowN| alarm_zone | rec_time | Optional | Integer | The alarm recognition time.<br />
}}{{TableRowN| alarm_zone | reset_time | Optional | Integer | The alarm reset time.<br />
}}{{TableRowN| alarm_zone | alarm_low | Optional | Floating Point | The alarm low limit.<br />
}}{{TableRowN| alarm_zone | alarm_high | Optional | Floating Point | The alarm high limit.<br />
}}{{TableRowN| alarm_zone | alarmschedule | Optional | Object | (See [[Sensaphone.net API/alarmschedule |Sensaphone.net API/alarmschedule]])<br />
}}{{TableRowN| zone | analog_zone | Optional | Object | Sub-object containing data for analog zones. 'null' if unsupported.<br />
}}{{TableRowN| analog_zone | clear_min | Optional | Boolean | Clear the minimum value.<br />
}}{{TableRowN| analog_zone | clear_max | Optional | Boolean | Clear the maximum value.<br />
}}{{TableRowN| analog_zone | calibration | Optional | Floating Point | The calibration factor applied to the "value".<br />
}}{{TableRowN| zone | table_zone | Optional | Object | Sub-object containing data for table-based zones. 'null' if unsupported.<br />
}}{{TableRowN| table_zone | table_low | Optional | Floating Point | The low table range for the zone. Used for 4-20mA sensors.<br />
}}{{TableRowN| table_zone | table_high | Optional | Floating Point | The high table range for the zone. Used for 4-20mA sensors.<br />
}}{{TableRowN| zone | log_zone | Optional | Object | Sub-object containing data for loggable zones. 'null' if unsupported.<br />
}}{{TableRowN| log_zone | report_mode | Optional | String | The reporting option.<br />
}}{{TableRowN| log_zone | alarm_interval | Optional | Integer | The datalogging interval for when in alarm.<br />
}}{{TableRowN| log_zone | normal_interval | Optional | Integer | The datalogging interval for when not in alarm.<br />
}}{{TableRowN| log_zone | enable | Optional | Boolean | Whether or not datalogging is enabled.<br />
}}{{TableRowN| zone | pulse_zone | Optional | Object | Sub-object containing data for pulse count capable zones. 'null' if unsupported.<br />
}}{{TableRowN| pulse_zone | enable | Optional | Boolean | Whether or not pulse counting is enabled for this zone.<br />
}}{{TableRowN| pulse_zone | multiply | Optional | Integer | The multiplication factor to apply to each pulse.<br />
}}{{TableRowN| pulse_zone | count | Optional | Integer | The number of pulses seen (after multiply has been applied)<br />
}}{{TableRowN| zone | runtime_zone | Optional | Object | Sub-object containing data for runtime capable zones. 'null' if unsupported.<br />
}}{{TableRowN| runtime_zone | enable | Optional | Boolean | Whether or not runtime is enabled for this zone.<br />
}}{{TableRowN| runtime_zone | runtime | Optional | String | The run time elapsed.<br />
}}{{TableRowN| zone | modbus_zone | Optional | Object | Sub-object containing data for modbus zones. 'null' if unsupported.<br />
}}{{TableRowN| modbus_zone | media_port | Optional | String | The modbus media port<br />
}}{{TableRowN| modbus_zone | slave_id | Optional | Integer | The modbus slave ID<br />
}}{{TableRowN| modbus_zone | command | Optional | String | The modbus command<br />
}}{{TableRowN| modbus_zone | address | Optional | Integer | The modbus address<br />
}}{{TableRowN| modbus_zone | byte_order | Optional | String | The modbus byte order<br />
}}{{TableRowN| modbus_zone | register_order | Optional | String | The modbus register order<br />
}}{{TableRowN| modbus_zone | register_size | Optional | String | The modbus register size<br />
}}{{TableRowN| modbus_zone | format | Optional | String | The modbus format<br />
}}{{TableRowN| modbus_zone | sign | Optional | String | The modbus sign<br />
}}{{TableRowN| modbus_zone | scaling_offset | Optional | Integer | The modbus scaling offset<br />
}}{{TableRowN| modbus_zone | scaling_factor | Optional | Integer | The modbus scaling factor<br />
}}{{TableRowN| modbus_zone | scaling_mode | Optional | String | The modbus scaling mode<br />
}}{{TableRowN| zone | output_zone | Optional | Object | Sub-object containing data for output zones. 'null' if unsupported.<br />
}}{{TableRowN| output_zone | mode | Optional | String | The output mode<br />
}}{{TableRowN| output_zone | mode_list | Optional | String | The list of output modes<br />
}}{{TableRowN| output_zone | set_point_on | Optional | Floating Point | The output set point for the "on" state.<br />
}}{{TableRowN| output_zone | set_point_off | Optional | Floating Point | The output set point for the "off" state.<br />
}}{{TableRowN| output_zone | value | Optional | Floating Point | *Write Only* set the value of the output zone<br />
}}{{TableRowN| zone | wireless_zone | Optional | Object | Sub-object containing data for wireless zones. 'null' if unsupported.<br />
}}{{TableRowN| wireless_zone | sampling_rate | Optional | Integer | The sampling rate for the sensor<br />
}}{{TableRowN| wireless_zone | serial_number | Optional | Integer | The serial number for the wireless sensor.<br />
}}{{TableEnd}}<br />
<br />
===POST===<br />
'''URI Mode Request URI's:'''<br />
*Acknowledge All Zone Alarms<br />
'''POST''' <nowiki>https://</nowiki>rest.sensaphone.net/api/v1/{ACCTID}/{SESSIONID}/device/{DEVICE_ID}/zone/{ZONE_ID}/alarm_zone/acknowledge_all_alarms/{true}<br />
<br />
'''JSON Mode Request URI:'''<br />
'''POST''' <nowiki>https://</nowiki>rest.sensaphone.net/api/v1/device/zone<br />
<br />
'''JSON Mode Request Properties'''<br />
{{TableStart|border_size=1<br />
}}{{TableRowN| '''Parent Property'''|'''Child Property''' |'''Type''' | '''Description'''<br />
}}{{TableRowN| &nbsp; | acctid | Integer | Account ID<br />
}}{{TableRowN| &nbsp; | session | Integer | Session ID<br />
}}{{TableRowN| &nbsp; | request_type | String | "read"<br />
}}{{TableRowN| &nbsp; | device | Array of Objects | The parent device of the "zone" resource. See [[Sensaphone.net_API/device|device]].<br />
}}{{TableRowN| device | zone | Array of Objects | The zone object.<br />
}}{{TableRowN| zone | zone_id | Integer | ID of the zone.<br />
}}{{TableRowN| zone | alarm_zone | Object | Sub-object containing data for alarmable zones<br />
}}{{TableRowN| alarm_zone | acknowledge_alarms | Array of Zone State | A write-only property to acknowledge specific alarms<br />
}}{{TableRowN| alarm_zone | acknowledge_all_alarms | Boolean | A write-only property to acknowledge all alarms for a zone<br />
}}{{TableEnd}}<br />
<nowiki>*</nowiki> "acknowledge_all_alarms" supersedes "acknowledge_alarms", if it is present in the request json other properties will be ignored<br />
<br />
'''JSON Mode Result Properties'''<br />
{{TableStart|border_size=1<br />
}}{{TableRowN| '''Parent Property''' |'''Child Property'''|'''Status'''| '''Type''' | '''Description'''<br />
}}{{TableRowN| &nbsp; | device | Required | Array of Objects | The parent device object.<br />
}}{{TableRowN| device | zone | Required | Array of Objects | The zone object.<br />
}}{{TableRowN| zone | zone_id | Required | Integer | ID of the zone.<br />
}}{{TableRowN| zone | alarm_zone | Required | Object | Sub-object containing data for alarmable zones. 'null' if unsupported.<br />
}}{{TableRowN| alarm_zone | acknowledge_alarms | Optional | Array of Zone State | A write-only property to acknowledge specific alarms<br />
}}{{TableRowN| alarm_zone | acknowledge_all_alarms | Optional | Boolean | A write-only property to acknowledge all alarms for a zone<br />
}}{{TableEnd}}<br />
<br />
=== Example JSON ===<br />
<br />
Acknowledge an alarm for a Zone<br />
<br />
*'''Request JSON''' <br />
<br />
{<br />
"request_type": "create",<br />
"resource": "device",<br />
"acctid": 987654,<br />
"session": "0123-4567-8901",<br />
"device": [<br />
{<br />
"device_id": 1234,<br />
"zone": [<br />
{<br />
"zone_id": 7,<br />
"alarm_zone": {<br />
"acknowledge_alarms": [<br />
11,<br />
4<br />
]<br />
}<br />
}<br />
]<br />
}<br />
]<br />
}<br />
<br />
*'''Response JSON''' <br />
<br />
{<br />
"result": {<br />
"success": true,<br />
"code": 0,<br />
"message": "OK",<br />
"properties": {<br />
"device": [<br />
{<br />
"device_id": 1234,<br />
"zone": [<br />
{<br />
"alarm_zone": [<br />
{<br />
"acknowledge_alarms": 11,<br />
"code": 0,<br />
"message": "OK",<br />
"success": true<br />
},<br />
{<br />
"acknowledge_alarms": 4,<br />
"code": 0,<br />
"message": "OK",<br />
"success": true<br />
}<br />
],<br />
"zone_id": 7<br />
}<br />
]<br />
}<br />
]<br />
}<br />
}<br />
}</div>
Derek
https://wiki.sensaphone.net/index.php?title=Main_Page&diff=153
Main Page
2015-07-10T18:22:02Z
<p>Derek: To access your devices and accounts on the Sensaphone.net website please go to:</p>
<hr />
<div>To access your devices and accounts on the Sensaphone.net website please go to:<br />
[https://www.sensaphone.net https://www.sensaphone.net]<br />
<br />
To access the Sensaphone.net API please go to:<br />
[[Sensaphone.net API]]</div>
Derek
https://wiki.sensaphone.net/index.php?title=Main_Page&diff=152
Main Page
2015-07-10T18:21:15Z
<p>Derek: fixed up</p>
<hr />
<div>To access the Sensaphone.net website please go to:<br />
[https://www.sensaphone.net https://www.sensaphone.net]<br />
<br />
To access the Sensaphone.net API please go to:<br />
[[Sensaphone.net API]]</div>
Derek
https://wiki.sensaphone.net/index.php?title=Sensaphone.net_API/device&diff=83
Sensaphone.net API/device
2015-05-19T13:39:31Z
<p>Derek: /* Example JSON */ Added missing "</p>
<hr />
<div>=[[Sensaphone.net API]]=<br />
<br />
==Specifications==<br />
The '''device''' resource allows access to the devices that are bound to the account.<br />
<br />
The device resource has the following properties:<br />
{{TableStart|border_size=1<br />
}}{{TableRowN| '''Parent Property''' | '''Property''' | '''Type''' | '''Description''' | '''Create''' | '''Delete''' | '''Read''' | '''Update'''<br />
}}{{TableRowN| ''<parent>'' | device | Object | The device object. | '''&#x2713;''' | '''&#x2713;''' | '''&#x2713;''' | '''n/a'''<br />
}}{{TableRowN| device | device_id | Integer | ID of the device. | ''' ''' | ''' ''' | '''&#x2713;''' | ''' '''<br />
}}{{TableRowN| device | id | String | Unique identifier located on the Device (Serial number, etc.) | ''' ''' | ''' ''' | '''&#x2713;''' | ''' '''<br />
}}{{TableRowN| device | name | String | Name of Device | ''' ''' | ''' ''' | '''&#x2713;''' | '''&#x2713;'''<br />
}}{{TableRowN| device | description | String | Short description of Device | ''' ''' | ''' ''' | '''&#x2713;''' | '''&#x2713;'''<br />
}}{{TableRowN| device | timezone | String | The timezone the Device is in | ''' ''' | ''' ''' | '''&#x2713;''' | '''&#x2713;'''<br />
}}{{TableRowN| device | location | Object | Contains location information for the device. | ''' ''' | ''' ''' | '''&#x2713;''' | '''&#x2713;'''<br />
}}{{TableRowN| location | address | Object | Address information for Device (See [[Sensaphone.net API/address|Sensaphone.net API/address]]) | ''' ''' | ''' ''' | '''&#x2713;''' | '''&#x2713;'''<br />
}}{{TableRowN| location | coordinates | Object | GPS Coordinates information for Device (See [[Sensaphone.net API/coordinates]]) | ''' ''' | ''' ''' | '''&#x2713;''' | '''&#x2713;'''<br />
}}{{TableRowN| device | firmware | String | Firmware version of Device | ''' ''' | ''' ''' | '''&#x2713;''' | '''&#x2713;'''<br />
}}{{TableRowN| device | default_schedule | Object | Alarm Schedule data (See [[Sensaphone.net API/alarmschedule]]) | ''' ''' | ''' ''' | '''&#x2713;''' | '''&#x2713;'''<br />
}}{{TableRowN| device | device_schedule | Object | Alarm Schedule data (See [[Sensaphone.net API/alarmschedule]]) | ''' ''' | ''' ''' | '''&#x2713;''' | '''&#x2713;'''<br />
}}{{TableRowN| device | zone | Array of Objects | Device Zone data (See [[Sensaphone.net API/zone|Sensaphone.net API/zone]]) | ''' ''' | ''' ''' | '''&#x2713;''' | '''&#x2713;'''<br />
}}{{TableRowN| device | offline_timeout | Integer | The number of minutes a device must be offline before it goes into alarm. | ''' ''' | ''' ''' | '''&#x2713;''' | '''&#x2713;'''<br />
}}{{TableRowN| device | product | String | The name of the product type | ''' ''' | ''' ''' | '''&#x2713;''' | ''' '''<br />
}}{{TableRowN| device | modbus_ports | Array of Objects | TBD | ''' ''' | ''' ''' | ''' ''' | ''' '''<br />
}}{{TableRowN| device | zone_meta | Array of Objects | TBD | ''' ''' | ''' ''' | '''&#x2713;''' | ''' '''<br />
}}{{TableRowN| zone_meta | zone | Zone Meta Type | TBD | ''' ''' | ''' ''' | '''&#x2713;''' | ''' '''<br />
}}{{TableRowN| zone_meta | children | Array of Zone Meta Type | TBD | ''' ''' | ''' ''' | '''&#x2713;''' | ''' '''<br />
}}{{TableRowN| device | is_offline_unack | Boolean | Whether or not an unacknowledged offline alarm exists. | ''' ''' | ''' ''' | '''&#x2713;''' | ''' '''<br />
}}{{TableRowN| device | is_online | Boolean | Whether or not the device is currently online. | ''' ''' | ''' ''' | '''&#x2713;''' | ''' '''<br />
}}{{TableRowN| device | standby_time | String | The number of minutes a device will be in standby mode. | ''' ''' | ''' ''' | '''&#x2713;''' | '''&#x2713;'''<br />
}}{{TableRowN| device | standby_mode | String | A device's standby mode. | ''' ''' | ''' ''' | '''&#x2713;''' | '''&#x2713;'''<br />
}}{{TableRowN| device | standby_status | String | A device's standby status | ''' ''' | ''' ''' | '''&#x2713;''' | ''' ''' <br />
}}{{TableRowN| device | battery_status | String | A device's battery status | ''' ''' | ''' ''' | '''&#x2713;''' | ''' ''' <br />
}}{{TableRowN| device | power_status | String | A device's power status | ''' ''' | ''' ''' | '''&#x2713;''' | ''' ''' <br />
}}{{TableRowN| device | connection_status | String | A device's connection status | ''' ''' | ''' ''' | '''&#x2713;''' | ''' ''' <br />
}}{{TableEnd}}<br />
<br />
<br />
'''Zone Meta Type'''<br />
{{TableStart|border_size=1<br />
}}{{TableRowN| '''Property''' |'''Type''' | '''Description'''<br />
}}{{TableRowN| zone_id | Integer | The Zone ID<br />
}}{{TableRowN| is_enabled | Integer | Is the zone enabled<br />
}}{{TableRowN| hide_if_disabled | Boolean | Hide the zone if disabled<br />
}}{{TableRowN| add_name | String | The add name<br />
}}{{TableEnd}}<br />
<br />
===GET===<br />
'''URI Mode Request URI's:'''<br />
*Receive all Device data for all Devices in a user's account<br />
'''GET''' <nowiki>https://</nowiki>rest.sensaphone.net/api/v1/{ACCTID}/{SESSIONID}/device<br />
<br />
*Receive all Device data for a specific Device <br />
'''GET''' <nowiki>https://</nowiki>rest.sensaphone.net/api/v1/{ACCTID}/{SESSIONID}/device/{DEVICE_ID}<br />
<br />
*Receive the alarm status of a Device <br />
'''GET''' <nowiki>https://</nowiki>rest.sensaphone.net/api/v1/{ACCTID}/{SESSIONID}/device/{DEVICE_ID}/status<br />
<br />
'''JSON Mode Request URI:'''<br />
'''POST''' <nowiki>https://</nowiki>rest.sensaphone.net/api/v1/device<br />
<br />
'''JSON Mode Request Properties'''<br />
{{TableStart|border_size=1<br />
}}{{TableRowN| '''Parent Property'''|'''Child Property''' |'''Type''' | '''Description'''<br />
}}{{TableRowN| &nbsp; | acctid | Integer | Account ID<br />
}}{{TableRowN| &nbsp; | session | Integer | Session ID<br />
}}{{TableRowN| &nbsp; | request_type | String | "read"<br />
}}{{TableRowN| &nbsp; | device | Array of Objects | The device object.<br />
}}{{TableEnd}}<br />
<br />
'''JSON Mode Response Properties'''<br />
{{TableStart|border_size=1<br />
}}{{TableRowN| '''Parent Property''' |'''Child Property'''|'''Status'''| '''Type''' | '''Description'''<br />
}}{{TableRowN| &nbsp; | device | Required | Array of Objects | The parent device object.<br />
}}{{TableRowN| device | device_id | Optional | Integer | ID of Device<br />
}}{{TableRowN| device | id | Optional | Integer | Unique identifier located on the Device (Serial number, etc.)<br />
}}{{TableRowN| device | name | Optional | String | Name of Device<br />
}}{{TableRowN| device | description | Optional | String | Short description of Device<br />
}}{{TableRowN| device | timezone | Optional | String | The timezone the Device is in <br />
}}{{TableRowN| device | location | Optional | Object | Contains location information for the device.<br />
}}{{TableRowN| location | address | Optional | Object | Address information for Device (See [[Sensaphone.net API/address]])<br />
}}{{TableRowN| location | coordinates | Optional | Object | GPS Coordinates information for Device (See [[Sensaphone.net API/coordinates]])<br />
}}{{TableRowN| device | firmware | Optional | String | Firmware version of Device<br />
}}{{TableRowN| device | default_schedule | Optional | Object | Alarm Schedule data (See [[Sensaphone.net API/alarmschedule]])<br />
}}{{TableRowN| device | device_schedule | Optional | Object | Alarm Schedule data (See [[Sensaphone.net API/alarmschedule]])<br />
}}{{TableRowN| device | zone | Optional | Array of Objects | Device Zone data (See [[Sensaphone.net API/zone|Sensaphone.net API/zone]])<br />
}}{{TableRowN| device | offline_timeout | Optional | Integer | The number of minutes a device must be offline before it goes into alarm.<br />
}}{{TableRowN| device | product | Optional | String | The name of the product type<br />
}}{{TableRowN| device | modbus_ports | Optional | Array of Objects | TBD<br />
}}{{TableRowN| device | zone_meta | Optional | Array ofObjects | TBD <br />
}}{{TableRowN| zone_meta | zone | Optional | Zone Meta Type | TBD <br />
}}{{TableRowN| zone_meta | children | Optional | Array of Zone Meta Type | TBD <br />
}}{{TableRowN| device | is_offline_unack | Optional | Boolean | Whether or not an '''unacknowledged''' offline alarm exists.<br />
}}{{TableRowN| device | is_online | Optional | Boolean | Whether or not the device is currently online.<br />
}}{{TableRowN| device | standby_time | Optional | String | The number of minutes a device will be in standby mode. <br />
}}{{TableRowN| device | standby_mode | Optional | String | A device's standby mode. <br />
}}{{TableRowN| device | standby_status | Optional | String | A device's standby status <br />
}}{{TableRowN| device | battery_status | Optional | String | A device's battery status <br />
}}{{TableRowN| device | power_status | Optional | String | A device's power status <br />
}}{{TableRowN| device | battery_value | Optional | String | A device's battery value <br />
}}{{TableRowN| device | power_value | Optional | String | A device's power value <br />
}}{{TableRowN| device | connection_status | Optional | String | A device's connection status <br />
}}{{TableEnd}}<br />
<br />
=====Example JSON=====<br />
Receive all Device information for a specific Device<br />
*'''Request JSON:'''<br />
{<br />
"acctid":987654,<br />
"session":"0123-4567-8901",<br />
"request_type":"read",<br />
"device": {<br />
"device_id":1234<br />
}<br />
}<br />
<br />
<br />
*'''Response JSON:'''<br />
<br />
{<br />
"result":<br />
{<br />
"success":true,<br />
"code":0,<br />
"message":"OK"<br />
},<br />
"response": <br />
{<br />
"device":[<br />
{<br />
"device_id": 1234,<br />
...<br />
}<br />
]<br />
} <br />
}<br />
<br />
===PUT===<br />
<br />
'''URI Mode Request URI's:'''<br />
*Edit the '''description''' of a Device <br />
'''PUT''' <nowiki>https://</nowiki>rest.sensaphone.net/api/v1/{ACCTID}/{SESSIONID}/device/{DEVICE_ID}/description/{DESCRIPTION}<br />
<br />
*Edit the '''name''' of a Device <br />
'''PUT''' <nowiki>https://</nowiki>rest.sensaphone.net/api/v1/{ACCTID}/{SESSIONID}/device/{DEVICE_ID}/name/{DEVICE_NAME} <br />
<br />
'''JSON Mode Request URI:'''<br />
'''POST''' <nowiki>https://</nowiki>rest.sensaphone.net/api/v1/device<br />
<br />
'''JSON Mode Request Properties'''<br />
{{TableStart|border_size=1<br />
}}{{TableRowN| '''Parent Property'''|'''Child Property''' |'''Type''' | '''Description'''<br />
}}{{TableRowN| &nbsp; | acctid | Integer | Account ID<br />
}}{{TableRowN| &nbsp; | session | Integer | Session ID<br />
}}{{TableRowN| &nbsp; | request_type | String | "update"<br />
}}{{TableRowN| &nbsp; | device | Array of Objects | The device object.<br />
}}{{TableRowN| device | device_id | Integer | ID of the device.<br />
}}{{TableRowN| device | '''CHILD PROPERTY''' | &nbsp; | Device's child properties to be edited*<br />
}}{{TableEnd}}<br />
<nowiki>*</nowiki>One or more '''device''' child properties below are required in addition to "device_id".<br />
<br />
'''JSON Mode Response Properties'''<br />
{{TableStart|border_size=1<br />
}}{{TableRowN| '''Parent Property''' |'''Child Property'''|'''Status'''| '''Type''' | '''Description'''<br />
}}{{TableRowN| &nbsp; | device | Required | Array of Objects | The parent device object.<br />
}}{{TableRowN| device | device_id | Optional | Integer | ID of Device<br />
}}{{TableRowN| device | name | Optional | String | Name of Device<br />
}}{{TableRowN| device | description | Optional | String | Short description of Device<br />
}}{{TableRowN| device | timezone | Optional | String | The timezone the Device is in <br />
}}{{TableRowN| device | location | Optional | Object | Contains location information for the device.<br />
}}{{TableRowN| location | address | Optional | Object | Address information for Device (See [[Sensaphone.net API/address|Sensaphone.net API/address]])<br />
}}{{TableRowN| location | coordinates | Optional | Object | GPS Coordinates information for Device (See [[Sensaphone.net API/coordinates]])<br />
}}{{TableRowN| device | firmware | Optional | String | Firmware version of Device<br />
}}{{TableRowN| device | default_schedule | Optional | Object | Alarm Schedule data (See [[Sensaphone.net API/alarmschedule]])<br />
}}{{TableRowN| device | device_schedule | Optional | Object | Alarm Schedule data (See [[Sensaphone.net API/alarmschedule]])<br />
}}{{TableRowN| device | zone | Optional | Array of Objects | Device Zone data (See [[Sensaphone.net API/zone|Sensaphone.net API/zone]])<br />
}}{{TableRowN| device | offline_timeout | Optional | Integer | The number of minutes a device must be offline before it goes into alarm.<br />
}}{{TableRowN| device | modbus_ports | Optional | Array of Objects | TBD<br />
}}{{TableRowN| device | standby_time | Optional | String | The number of minutes a device will be in standby mode. <br />
}}{{TableRowN| device | standby_mode | Optional | String | A device's standby mode. <br />
}}{{TableEnd}}<br />
<br />
===POST===<br />
'''Adding a device'''<br />
<br />
The preferred method to add a new Device is to use the JSON Mode Request. If the URI Mode Request is used you will be adding a Device with only the '''id''' value (not to be confused with the '''device_id'''), all other values will be left empty until a PUT request is used. With the JSON Mode Request you can add a Device with all values defined in one step.<br />
<br />
'''URI Mode Request URI:'''<br />
*Add a new Device <br />
'''POST''' <nowiki>https://</nowiki>rest.sensaphone.net/api/v1/{ACCTID}/{SESSIONID}/device/id/{DEVICEID}<br />
<br />
'''JSON Mode Request URI:'''<br />
'''POST''' <nowiki>https://</nowiki>rest.sensaphone.net/api/v1/device<br />
<br />
'''JSON Mode Request Properties'''<br />
{{TableStart|border_size=1<br />
}}{{TableRowN| '''Parent Property'''|'''Child Property''' |'''Type''' | '''Description'''<br />
}}{{TableRowN| &nbsp; | acctid | Integer | Account ID<br />
}}{{TableRowN| &nbsp; | session | Integer | Session ID<br />
}}{{TableRowN| &nbsp; | request_type | String | "create"<br />
}}{{TableRowN| &nbsp; | device | Array of Objects | The device object.<br />
}}{{TableRowN| device | id | Integer | Unique identifier located on the Device (Serial number, etc.)<br />
}}{{TableEnd}}<br />
<br />
'''JSON Mode Response Properties'''<br />
{{TableStart|border_size=1<br />
}}{{TableRowN| '''Parent Property''' |'''Child Property'''|'''Status'''| '''Type''' | '''Description'''<br />
}}{{TableRowN| &nbsp; | device | Required | Array of Objects | The parent device object.<br />
}}{{TableRowN| device | device_id | Optional | Integer | ID of Device<br />
}}{{TableRowN| device | id | Optional | Integer | Unique identifier located on the Device (Serial number, etc.)<br />
}}{{TableRowN| device | name | Optional | String | Name of Device<br />
}}{{TableRowN| device | description | Optional | String | Short description of Device<br />
}}{{TableRowN| device | location | Optional | Object | Contains location information for the device.<br />
}}{{TableRowN| location | address | Optional | Object | Address information for Device (See [[Sensaphone.net API/address|Sensaphone.net API/address]])<br />
}}{{TableRowN| location | coordinates | Optional | Object | GPS Coordinates information for Device (See [[Sensaphone.net API/coordinates]])<br />
}}{{TableRowN| device | firmware | Optional | String | Firmware version of Device<br />
}}{{TableRowN| device | default_schedule | Optional | Object | Alarm Schedule data (See [[Sensaphone.net API/alarmschedule]])<br />
}}{{TableRowN| device | device_schedule | Optional | Object | Alarm Schedule data (See [[Sensaphone.net API/alarmschedule]])<br />
}}{{TableRowN| device | zone | Optional | Array of Objects | Device Zone data (See [[Sensaphone.net API/zone|Sensaphone.net API/zone]])<br />
}}{{TableRowN| device | offline_timeout | Optional | Integer | The number of minutes a device must be offline before it goes into alarm.<br />
}}{{TableRowN| device | modbus_ports | Optional | Array of Objects | TBD<br />
}}{{TableEnd}}<br />
<br />
<br />
<br />
<br />
'''Acknowledging Alarms'''<br />
<br />
'''URI Mode Request URI:'''<br />
*Acknowledge All Alarms<br />
'''POST''' <nowiki>https://</nowiki>rest.sensaphone.net/api/v1/{ACCTID}/{SESSIONID}/device/{DEVICE_ID}/acknowledge_all_alarms/{true}<br />
<br />
'''JSON Mode Request Properties'''<br />
{{TableStart|border_size=1<br />
}}{{TableRowN| '''Parent Property'''|'''Child Property''' |'''Type''' | '''Description'''<br />
}}{{TableRowN| &nbsp; | acctid | Integer | Account ID<br />
}}{{TableRowN| &nbsp; | session | Integer | Session ID<br />
}}{{TableRowN| &nbsp; | request_type | String | "create"<br />
}}{{TableRowN| &nbsp; | device | Array of Objects | The device object.<br />
}}{{TableRowN| device | device_id | Integer | ID of Device<br />
}}{{TableRowN| device | ack_offline_alarm | Boolean | A write-only property that will acknowledge a device offline alarm<br />
}}{{TableRowN| device | acknowledge_all_alarms | Boolean | A write-only property that will acknowledge all alarms for a device, including all device alarms and all zone alarms<br />
}}{{TableEnd}}<br />
<nowiki>*</nowiki> "acknowledge_all_alarms" supersedes "ack_offline_alarm", if it is present in the request json other properties will be ignored<br />
<br />
===DELETE===<br />
'''URI Mode Request URI:'''<br />
*Delete a Device from an account <br />
'''DELETE''' <nowiki>https://</nowiki>rest.sensaphone.net/api/v1/{ACCTID}/{SESSIONID}/device/{DEVICE_ID}<br />
<br />
'''JSON Mode Request URI:'''<br />
'''POST''' <nowiki>https://</nowiki>rest.sensaphone.net/api/v1/device<br />
<br />
'''JSON Mode Request Properties'''<br />
{{TableStart|border_size=1<br />
}}{{TableRowN| '''Parent Property'''|'''Child Property''' |'''Type''' | '''Description'''<br />
}}{{TableRowN| &nbsp; | acctid | Integer | Account ID<br />
}}{{TableRowN| &nbsp; | session | Integer | Session ID<br />
}}{{TableRowN| &nbsp; | request_type | String | "delete"<br />
}}{{TableRowN| &nbsp; | device | Array of Objects | The device object.<br />
}}{{TableRowN| device | device_id | Integer | ID of the device.<br />
}}{{TableEnd}}</div>
Derek