Difference between revisions of "Sensaphone.net API/feature"

From Sensaphone.net
Jump to: navigation, search
(Created page with "=Sensaphone.net API= ==Specifications== The account resource The account resource has the following properties: {{TableStart|border_size=1 }}{{TableRowN| '''Parent Proper...")
 
(→‎Specifications)
Line 1: Line 1:
 
=[[Sensaphone.net API]]=
 
=[[Sensaphone.net API]]=
 
==Specifications==
 
==Specifications==
−
The account resource
+
The feature resource
  
−
The account resource has the following properties:
+
The feature resource has the following properties:
 
{{TableStart|border_size=1
 
{{TableStart|border_size=1
 
}}{{TableRowN| '''Parent Property'''|'''Property'''  | '''Type'''    | '''Description'''        | '''Create''' | '''Delete''' | '''Read''' | '''Update'''
 
}}{{TableRowN| '''Parent Property'''|'''Property'''  | '''Type'''    | '''Description'''        | '''Create''' | '''Delete''' | '''Read''' | '''Update'''
−
}}{{TableRowN| ''<parent>''         | account    | Object        | The account object.  | ''' ''' | ''' ''' | '''&#x2713;''' | '''n/a'''
+
}}{{TableRowN| ''<parent>''           | feature              | Object | The feature linked to the account              | ''' ''' | ''' ''' | '''&#x2713;''' | '''&#x2713;'''
−
}}{{TableRowN| account          | name              | String |  The name of the account              | ''' ''' | ''' ''' | '''&#x2713;''' | '''&#x2713;'''
+
−
}}{{TableRowN| account          | timezone              | String | The timezone which the account is in                | ''' ''' | ''' ''' | '''&#x2713;''' | '''&#x2713;'''
+
−
}}{{TableRowN| account          | feature              | Object | The feature linked to the account              | ''' ''' | ''' ''' | '''&#x2713;''' | '''&#x2713;'''
+
 
}}{{TableRowN| feature          | feature_id              | Integer | The ID of the feature              | ''' ''' | ''' ''' | '''&#x2713;''' |  ''' '''
 
}}{{TableRowN| feature          | feature_id              | Integer | The ID of the feature              | ''' ''' | ''' ''' | '''&#x2713;''' |  ''' '''
 
}}{{TableRowN| feature          | resource              | String | The resource of the feature              | ''' ''' | ''' ''' | '''&#x2713;''' |  ''' '''
 
}}{{TableRowN| feature          | resource              | String | The resource of the feature              | ''' ''' | ''' ''' | '''&#x2713;''' |  ''' '''
Line 21: Line 18:
 
===GET===
 
===GET===
 
'''URI Mode Request URI's:'''
 
'''URI Mode Request URI's:'''
−
*Retrieve all the account data
+
*Retrieve all the account features
−
   '''GET''' <nowiki>https://</nowiki>rest.sensaphone.net/api/v1/{ACCTID}/{SESSIONID}/account
+
   '''GET''' <nowiki>https://</nowiki>rest.sensaphone.net/api/v1/{ACCTID}/{SESSIONID}/account/feature
  
−
*Retrieve the account name
+
*Retrieve all the device features
−
   '''GET''' <nowiki>https://</nowiki>rest.sensaphone.net/api/v1/{ACCTID}/{SESSIONID}/account/name
+
   '''GET''' <nowiki>https://</nowiki>rest.sensaphone.net/api/v1/{ACCTID}/{SESSIONID}/device/feature
  
 
'''JSON Mode Request URI:'''
 
'''JSON Mode Request URI:'''
Line 36: Line 33:
 
}}{{TableRowN| &nbsp;                  | session                | Integer          | Session ID
 
}}{{TableRowN| &nbsp;                  | session                | Integer          | Session ID
 
}}{{TableRowN| &nbsp;                  | request_type          | String          | "read"
 
}}{{TableRowN| &nbsp;                  | request_type          | String          | "read"
−
}}{{TableRowN| ''<parent>''            | account           | Array of Objects | The accounts object
+
}}{{TableRowN| ''<parent>''            | feature           | Array of Objects | The features object
 
}}{{TableEnd}}
 
}}{{TableEnd}}
  
Line 43: Line 40:
 
}}{{TableRowN| '''Parent Properties'''  | '''Child Property'''    | '''Status''' | '''Type'''      | '''Description'''
 
}}{{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| &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               
−
}}{{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          | feature_id          | Required          | Integer | The ID of the feature             
 
}}{{TableRowN| feature          | resource            | Optional        | String | The resource of the feature             
 
}}{{TableRowN| feature          | resource            | Optional        | String | The resource of the feature             

Revision as of 09:01, 28 May 2015

Sensaphone.net API

Specifications

The feature resource

The feature resource has the following properties:

Parent PropertyProperty Type Description Create Delete Read Update
<parent> feature Object The feature linked to the account ✓ ✓
feature feature_id Integer The ID of the feature ✓
feature resource String The resource of the feature ✓
feature description String The description of the feature ✓
feature resource_id Integer The ID of the resource ✓
feature parent_ids Array of Integers The IDs of the parent features ✓
feature option String The value of the feature ✓ ✓
feature is_hidden Boolean Is the feature hidden ✓

GET

URI Mode Request URI's:

  • Retrieve all the account features 
  GET https://rest.sensaphone.net/api/v1/{ACCTID}/{SESSIONID}/account/feature
  • Retrieve all the device features
  GET https://rest.sensaphone.net/api/v1/{ACCTID}/{SESSIONID}/device/feature

JSON Mode Request URI: 

  POST https://rest.sensaphone.net/api/v1/account

JSON Mode Request Properties

Parent Properties Child Properties Type Description
  acctid Integer Account ID
  session Integer Session ID
  request_type String "read"
<parent> feature Array of Objects The features object

JSON Mode Response Properties

Parent Properties Child Property Status Type Description
  <parent object(s)> Optional Array of Objects The parent(s) specified in the request.
<parent> feature Optional Object The feature linked to the account
feature feature_id Required Integer The ID of the feature
feature resource Optional String The resource of the feature
feature description Optional String The description of the feature
feature resource_id Optional Integer The ID of the resource
feature parent_ids Optional Array of Integers The IDs of the parent features
feature option Optional String The value of the feature
feature is_hidden Optional Boolean Is the feature hidden

Example JSON

Receive coordinates for a device.

  • Request JSON:
{
  "acctid": 987654,
  "sessionid": "0123-4567-8901",
  "request_type": "read",
  "account": null
}
  • Response JSON
{
  "result":
  {
    "success": true,
    "code": 0,
    "message": "OK"
  },
  "response":
  {
    "account": [
    {
       "name":"Tim's Awesome Account",
       "timezone":"Central Time"
    }]
  }
}

PUT

URI Mode Request URI's:

  • Edit the account's name.
  PUT https://rest.sensaphone.net/api/v1/{ACCTID}/{SEESIONID}/account/{NAME}

JSON Mode Request URI: 

  POST https://rest.sensaphone.net/api/v1/device/account

JSON Mode Request Properties

Parent Properties Child Properties Type Description
  acctid Integer Account ID
  session Integer Session ID
  request_type String "read"
<parent> account Array of Objects The accounts object
account CHILD PROPERTY   Account's child properties to be edited*

*One or more account child properties listed below is required

JSON Mode Response Properties

Parent Properties Child Property Status Type Description
  <parent object(s)> Optional Array of Objects The parent(s) specified in the request.
<parent> account Required Array of Objects Account Data
account name Optional String The name of the account
account timezone Optional String The timezone which the account is in
account feature Optional Object The feature linked to the account
feature feature_id Required Integer The ID of the feature
feature option Optional String The value of the feature
Retrieved from "https://wiki.sensaphone.net/index.php?title=Sensaphone.net_API/feature&oldid=90"