Sensaphone.net API/history - Revision history

Mwood: /* Event Log */

2025-08-11T13:24:22Z

‎Event Log

Mwood: /* Audit Log */

2025-08-11T13:22:48Z

‎Audit Log

Mwood: /* Data Log */ Add better description of 'begin_offset' and 'record_offset'

2025-08-11T13:19:29Z

‎Data Log: Add better description of 'begin_offset' and 'record_offset'

Derek: /* Event Log */

2017-10-25T14:52:39Z

‎Event Log

Derek: /* Data Log */

2017-10-25T14:52:18Z

‎Data Log

Derek: /* Audit Log */

2017-10-25T14:51:56Z

‎Audit Log

Derek: /* Timestamps */

2017-10-25T14:32:45Z

‎Timestamps

Tim: /* Timestamps */

2015-06-29T18:03:07Z

‎Timestamps

Tim: /* Timestamps */

2015-06-29T18:01:20Z

‎Timestamps

Tim: /* Sensaphone.net API */

2015-06-29T17:35:36Z

‎Sensaphone.net API

@@ Line 201: / Line 201: @@
 }}{{TableRowN|  start                     | Optional   | Integer           | the start time (Sensaphone timestamp)
 }}{{TableRowN| end                      | Optional   | Integer           | the end time (Sensaphone timestamp)
-}}{{TableRowN|  begin_offset         | Optional   | Integer           |  the beginning offset of the first record
+}}{{TableRowN|  begin_offset         | Optional   | Integer           |  page through results by incrementing this number by multiples of 'record_offset'
-}}{{TableRowN|  record_offset        | Optional   | Integer           |  the offset from the beginning
+}}{{TableRowN|  record_offset        | Optional   | Integer           |  number of records returned per query; or 'page' size
 }}{{TableEnd}}

@@ Line 34: / Line 34: @@
 }}{{TableRowN|  start                     | Optional   | Integer           | the start time (Sensaphone timestamp)
 }}{{TableRowN| end                      | Optional   | Integer           | the end time (Sensaphone timestamp)
-}}{{TableRowN|  begin_offset         | Optional   | Integer           |  the beginning offset of the first record
+}}{{TableRowN|  begin_offset         | Optional   | Integer           |  page through results by incrementing this number by multiples of 'record_offset'
-}}{{TableRowN|  record_offset        | Optional   | Integer           |  the offset from the beginning
+}}{{TableRowN|  record_offset        | Optional   | Integer           |  number of records returned per query; or 'page' size
 }}{{TableEnd}}

@@ Line 86: / Line 86: @@
 {{TableStart|border_size=1
 }}{{TableRowN| '''Property'''           |'''Status'''     | '''Type'''               | '''Description'''
-}}{{TableRowN|  log_points                 | Optional   | Array of Integer          | list of variable ids
+}}{{TableRowN|  log_points              | Optional        | Array of Integer         | list of variable ids
-}}{{TableRowN|  status               | Optional   | Array of String          | list of AlarmStatus ("normal", "dependency", "alarm")
+}}{{TableRowN|  status                  | Optional        | Array of String          | list of AlarmStatus ("normal", "dependency", "alarm")
-}}{{TableRowN|  start                     | Optional   | Integer           | the start time (Sensaphone timestamp)
+}}{{TableRowN|  start                   | Optional        | Integer                  | the start time (Sensaphone timestamp)
-}}{{TableRowN| end                      | Optional   | Integer           | the end time (Sensaphone timestamp)
+}}{{TableRowN| end                      | Optional        | Integer                  | the end time (Sensaphone timestamp)
-}}{{TableRowN|  begin_offset         | Optional   | Integer           |  the beginning offset of the first record
+}}{{TableRowN|  begin_offset            | Optional        | Integer                  | page through results by incrementing this number by multiples of 'record_offset'
-}}{{TableRowN|  record_offset        | Optional   | Integer           |  the offset from the beginning
+}}{{TableRowN|  record_offset           | Optional        | Integer                  | number of records returned per query; or 'page' size
 }}{{TableEnd}}
@@ Line 98: / Line 98: @@
 '''Data Log Request Properties'''
 {{TableStart|border_size=1
-}}{{TableRowN| '''Parent Property''' |'''Child Property'''| '''Type'''        | '''Description'''
+}}{{TableRowN| '''Parent Property''' |'''Child Property'''  | '''Type'''  | '''Description'''
-}}{{TableRowN| &nbsp;                | acctid                   | Integer        | Account ID
+}}{{TableRowN| &nbsp;                | acctid               | Integer     | Account ID
-}}{{TableRowN| &nbsp;                  | session                | String         | Session ID
+}}{{TableRowN| &nbsp;                | session              | String      | Session ID
-}}{{TableRowN| &nbsp;                  | request_type         | String       | "read"
+}}{{TableRowN| &nbsp;                | request_type         | String      | "read"
-}}{{TableRowN| &nbsp;                  | history                  | Object      | The History object
+}}{{TableRowN| &nbsp;                | history              | Object      | The History object
-}}{{TableRowN| history                | data_log                | Object       | Data Log Filter Options
+}}{{TableRowN| history               | data_log             | Object      | Data Log Filter Options
 }}{{TableEnd}}

@@ Line 199: / Line 199: @@
 }}{{TableRowN|  user_ids               | Optional   | Array of Integer          | list of user ids
 }}{{TableRowN|  event_types               | Optional   | Array of String          | list of event types
-}}{{TableRowN|  start                     | Optional   | Integer           | the start time (unix time)
+}}{{TableRowN|  start                     | Optional   | Integer           | the start time (Sensaphone timestamp)
-}}{{TableRowN| end                      | Optional   | Integer           | the end time (unix time)
+}}{{TableRowN| end                      | Optional   | Integer           | the end time (Sensaphone timestamp)
 }}{{TableRowN|  begin_offset         | Optional   | Integer           |  the beginning offset of the first record
 }}{{TableRowN|  record_offset        | Optional   | Integer           |  the offset from the beginning

@@ Line 88: / Line 88: @@
 }}{{TableRowN|  log_points                 | Optional   | Array of Integer          | list of variable ids
 }}{{TableRowN|  status               | Optional   | Array of String          | list of AlarmStatus ("normal", "dependency", "alarm")
-}}{{TableRowN|  start                     | Optional   | Integer           | the start time (unix time)
+}}{{TableRowN|  start                     | Optional   | Integer           | the start time (Sensaphone timestamp)
-}}{{TableRowN| end                      | Optional   | Integer           | the end time (unix time)
+}}{{TableRowN| end                      | Optional   | Integer           | the end time (Sensaphone timestamp)
 }}{{TableRowN|  begin_offset         | Optional   | Integer           |  the beginning offset of the first record
 }}{{TableRowN|  record_offset        | Optional   | Integer           |  the offset from the beginning
@@ Line 138: / Line 138: @@
+     }
+   }
 ==Data Log Points==
 Poll the Data Log Points to get the possible logable points to use for the Data Log

@@ Line 14: / Line 14: @@
 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:
-  getSensaphoneTimestamp( year, month, day, hour, minute, second )  {
+  getSensaphoneTimestamp( year, month, day, hours, minutes, seconds )  {
    return ((seconds                      % 60)) +
              ((minutes      * 60)        % 3600) +
@@ Line 20: / Line 20: @@
              ((day          * 86400)     % 2678400) +
              ((month        * 2678400)   % 32140800) +
-             ((year % 100   * 32140800))
+             ((year % 100   * 32140800));
+   }

← Older revision		Revision as of 18:01, 29 June 2015
Line 10:		Line 10:

	==Timestamps==		==Timestamps==
		+	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.

		+	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:
		+
		+	getSensaphoneTimestamp( year, month, day, hour, minute, second ) {
		+	return ((seconds % 60)) +
		+	((minutes * 60) % 3600) +
		+	((hours * 3600) % 86400) +
		+	((day * 86400) % 2678400) +
		+	((month * 2678400) % 32140800) +
		+	((year % 100 * 32140800))
		+	}

	==Audit Log==		==Audit Log==

@@ Line 8: / Line 8: @@
 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.
    /history/audit_log/var_ids/{1234,9876}/changes/{create}
 ==Audit Log==