Latest revision as of 09:52, 25 October 2017

Sensaphone.net API

Access

The History API allows access to the Audit Log, the Data Log, and the Event Log

Specifications

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}

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

Audit Log

Audit Log Filter Options

GET

Audit Log Request Properties

Audit Log Response Properties

• Receive all changes for a variable:
• URI Mode:

 GET https://rest.sensaphone.net/api/v1/{ACCOUNT}/{SESSION}/history/audit_log/var_ids/{1234}

• JSON Mode:

 POST https://rest.sensaphone.net/api/v1/{ACCOUNT}/{SESSION}/history/audit_log/

 {
 "request_type": "read",
 "history":
   {
     "audit_log": {
       "var_ids" : [1234]
     }
   }
 }

Data Log

Data Log Filter Options

GET

Data Log Request Properties

Data Log Response Properties

• Receive the last 50 logged datas for a log point
• URI Mode:

 GET https://rest.sensaphone.net/api/v1/{ACCOUNT}/{SESSION}/history/data_log/log_points/{1234}/begin_offset/{0}/record_offset/{50}

• JSON Mode:

 POST https://rest.sensaphone.net/api/v1/{ACCOUNT}/{SESSION}/history/data_log

 {
 "request_type": "read",
 "history":
   {
     "data_log": {
       "log_points" : [1234],
       "begin_offset" : 0,
       "record_offset" : 50
     }
   }
 }

Data Log Points

Poll the Data Log Points to get the possible logable points to use for the Data Log

GET

Data Log Points Request Properties

Data Log Points Response Properties

• Receive all data logable points for a device:
• URI Mode:

 GET https://rest.sensaphone.net/api/v1/{ACCOUNT}/{SESSION}/history/data_log_points/resource_type/{device}/device_id/{1234}

• JSON Mode:

 POST https://rest.sensaphone.net/api/v1/{ACCOUNT}/{SESSION}/history/data_log_points

 {
 "request_type": "read",
 "history":
   {
     "data_log_points": {
       "resource_type" : "device",
       "device_id" : 1234
     }
   }
 }

Event Log

Event Log Filter Options

GET

Event Log Request Properties

Event Log Response Properties

• Receive last 50 "Alarms Events" for a device:
• URI Mode:

 GET https://rest.sensaphone.net/api/v1/{ACCOUNT}/{SESSION}/history/event_log/device_ids/{1234}/event_types/{alarm}/begin_offset/{0}/record_offset/{50}

• JSON Mode:

 POST https://rest.sensaphone.net/api/v1/{ACCOUNT}/{SESSION}/history/event_log

 {
 "request_type": "read",
 "history":
   {
     "event_log": {
       "event_types" : ["alarm"],
       "device_ids" : [1234],
       "begin_offset" : 0,
       "record_offset" : 50
     }
   }
 }