Sensaphone.net API/feature - Revision history

Mwood: /* Sensaphone.net API */ Update Session data type.

2025-07-10T15:33:18Z

‎Sensaphone.net API: Update Session data type.

Tim: /* GET */

2015-05-28T15:02:25Z

‎GET

Tim: /* PUT */

2015-05-28T15:02:00Z

‎PUT

Tim: /* GET */

2015-05-28T15:00:58Z

‎GET

Tim: /* Specifications */

2015-05-28T15:00:20Z

‎Specifications

Tim: /* PUT */

2015-05-28T14:59:52Z

‎PUT

Tim: /* PUT */

2015-05-28T14:59:15Z

‎PUT

Tim: /* PUT */

2015-05-28T14:58:54Z

‎PUT

Tim: /* PUT */

2015-05-28T14:54:55Z

‎PUT

Tim: Feature Read Example

2015-05-28T14:52:02Z

Feature Read Example

@@ Line 31: / Line 31: @@
 }}{{TableRowN| '''Parent Properties''' | '''Child Properties''' | '''Type'''       | '''Description'''
 }}{{TableRowN| &nbsp;                  | acctid                 | Integer          | Account ID
-}}{{TableRowN| &nbsp;                  | session                | Integer          | Session ID
+}}{{TableRowN| &nbsp;                  | session                | String           | Session Token
 }}{{TableRowN| &nbsp;                  | request_type           | String           | "read"
 }}{{TableRowN| ''<parent>''            | feature            | Array of Objects | The features object
@@ Line 100: / Line 100: @@
 }}{{TableRowN| '''Parent Properties''' | '''Child Properties'''   | '''Type'''       | '''Description'''
 }}{{TableRowN| &nbsp;                  | acctid                 | Integer          | Account ID
-}}{{TableRowN| &nbsp;                  | session                | Integer          | Session ID
+}}{{TableRowN| &nbsp;                  | session                | String           | Session Token
 }}{{TableRowN| &nbsp;                  | request_type           | String           | "read"
 }}{{TableRowN| ''<parent>''            | feature            | Array of Objects | The feature object

@@ Line 40: / Line 40: @@
 }}{{TableRowN| '''Parent Properties'''   | '''Child Property'''    | '''Status''' | '''Type'''       | '''Description'''
 }}{{TableRowN| &nbsp;                    | ''<parent object(s)>''  | Optional     | Array of Objects | The parent(s) specified in the request.
-}}{{TableRowN| ''<parent>''           | feature             | Required       | Object | The feature linked to the account
+}}{{TableRowN| ''<parent>''           | feature             | Required       | Object | The feature linked to the account/device
 }}{{TableRowN| feature          | feature_id          | Required          | Integer | The ID of the feature
 }}{{TableRowN| feature          | resource            | Optional        | String | The resource of the feature

@@ Line 103: / Line 103: @@
 }}{{TableRowN| &nbsp;                  | request_type           | String           | "read"
 }}{{TableRowN| ''<parent>''            | feature            | Array of Objects | The feature object
-}}{{TableRowN| feature             | '''''CHILD PROPERTY''''' | &nbsp;           | Account's child properties to be edited*
+}}{{TableRowN| feature             | '''''CHILD PROPERTY''''' | &nbsp;           | Feature's child properties to be edited*
 }}{{TableEnd}}

@@ Line 40: / Line 40: @@
 }}{{TableRowN| '''Parent Properties'''   | '''Child Property'''    | '''Status''' | '''Type'''       | '''Description'''
 }}{{TableRowN| &nbsp;                    | ''<parent object(s)>''  | Optional     | Array of Objects | The parent(s) specified in the request.
-}}{{TableRowN| ''<parent>''           | feature             | Optional       | Object | The feature linked to the account
+}}{{TableRowN| ''<parent>''           | feature             | Required       | Object | The feature linked to the account
 }}{{TableRowN| feature          | feature_id          | Required          | Integer | The ID of the feature
 }}{{TableRowN| feature          | resource            | Optional        | String | The resource of the feature

@@ Line 6: / Line 6: @@
 {{TableStart|border_size=1
 }}{{TableRowN| '''Parent Property'''|'''Property'''  | '''Type'''     | '''Description'''        | '''Create''' | '''Delete''' | '''Read''' | '''Update'''
-}}{{TableRowN| ''<parent>''           | feature              | Object | The feature linked to the account               | ''' ''' | ''' ''' | '''&#x2713;''' | '''&#x2713;'''
+}}{{TableRowN| ''<parent>''           | feature              | Array of Object | The feature linked to the account/device               | ''' ''' | ''' ''' | '''&#x2713;''' | '''&#x2713;'''
 }}{{TableRowN| feature          | feature_id              | Integer | The ID of the feature              | ''' ''' | ''' ''' | '''&#x2713;''' |  ''' '''
 }}{{TableRowN| feature          | resource              | String | The resource of the feature              | ''' ''' | ''' ''' | '''&#x2713;''' |  ''' '''

@@ Line 105: / Line 105: @@
 }}{{TableRowN| account             | '''''CHILD PROPERTY''''' | &nbsp;           | Account's child properties to be edited*
 }}{{TableEnd}}
 '''JSON Mode Response Properties'''

@@ Line 111: / Line 111: @@
 }}{{TableRowN| '''Parent Properties'''   | '''Child Property'''    | '''Status''' | '''Type'''       | '''Description'''
 }}{{TableRowN| &nbsp;                    | ''<parent object(s)>''  | Optional     | Array of Objects | The parent(s) specified in the request.
-}}{{TableRowN| ''<parent>''              | account             | Required     | Array of Objects | Account Data
+}}{{TableRowN| ''<parent>''       | feature             | Optional       | Object | The feature linked to the account/device
-}}{{TableRowN| account          | name              | Optional      | String | The name of the account
-}}{{TableRowN| account          | timezone              | Optional      | String | The timezone which the account is in
-}}{{TableRowN| account          | feature             | Optional       | Object | The feature linked to the account
 }}{{TableRowN| feature          | feature_id          | Required          | Integer | The ID of the feature
 }}{{TableRowN| feature          | option          | Optional          | String | The value of the feature
 }}{{TableEnd}}

@@ Line 89: / Line 89: @@
 ===PUT===
 '''URI Mode Request URI's:'''
-*Edit the account's name.
+*Change an account feature
-    '''PUT''' https://rest.sensaphone.net/api/v1/{ACCTID}/{SEESIONID}/account/{NAME}
+    '''PUT''' https://rest.sensaphone.net/api/v1/{ACCTID}/{SEESIONID}/account/feature/option/{NEW_OPTION}
 '''JSON Mode Request URI:'''
-    '''POST''' https://rest.sensaphone.net/api/v1/device/account
+   '''POST''' https://rest.sensaphone.net/api/v1/account/feature
 '''JSON Mode Request Properties'''

@@ Line 51: / Line 51: @@
 ====Example JSON====
-Receive coordinates for a device.
+Receive all the account features' option
 *'''Request JSON:'''
@@ Line 58: / Line 58: @@
     "sessionid": "0123-4567-8901",
     "request_type": "read",
-    "account": null
+    "account": [
+  }
@@ Line 73: / Line 77: @@
       "account": [
+      {
-         "name":"Tim's Awesome Account",
+         "feature": [
-        "timezone":"Central Time"
       }]
+    }