View source for Sensaphone.net API/feature

=[[Sensaphone.net API]]=
==Specifications==
The account resource

The account resource has the following properties:
{{TableStart|border_size=1
}}{{TableRowN| '''Parent Property'''|'''Property'''  | '''Type'''     | '''Description'''        | '''Create''' | '''Delete''' | '''Read''' | '''Update'''
}}{{TableRowN| ''<parent>''         | account    | Object         | The account object.  | ''' ''' | ''' ''' | '''&#x2713;''' | '''n/a'''
}}{{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          | resource              | String | The resource of the feature              | ''' ''' | ''' ''' | '''&#x2713;''' |  ''' '''
}}{{TableRowN| feature          | description              | String | The description of the feature              | ''' ''' | ''' ''' | '''&#x2713;''' |  ''' '''
}}{{TableRowN| feature          | resource_id              | Integer | The ID of the resource              | ''' ''' | ''' ''' | '''&#x2713;''' |  ''' '''
}}{{TableRowN| feature          | parent_ids              | Array of Integers | The IDs of the parent features              | ''' ''' | ''' ''' | '''&#x2713;''' |  ''' '''
}}{{TableRowN| feature          | option              | String | The value of the feature              | ''' ''' | ''' ''' | '''&#x2713;''' |  '''&#x2713;'''
}}{{TableRowN| feature          | is_hidden              | Boolean |  Is the feature hidden             | ''' ''' | ''' ''' | '''&#x2713;''' |  ''' '''
}}{{TableEnd}}

===GET===
'''URI Mode Request URI's:'''
*Retrieve all the account data 
   '''GET''' <nowiki>https://</nowiki>rest.sensaphone.net/api/v1/{ACCTID}/{SESSIONID}/account

*Retrieve the account name
   '''GET''' <nowiki>https://</nowiki>rest.sensaphone.net/api/v1/{ACCTID}/{SESSIONID}/account/name

'''JSON Mode Request URI:'''
   '''POST''' <nowiki>https://</nowiki>rest.sensaphone.net/api/v1/account

'''JSON Mode Request Properties'''
{{TableStart|border_size=1
}}{{TableRowN| '''Parent Properties''' | '''Child Properties''' | '''Type'''       | '''Description'''
}}{{TableRowN| &nbsp;                  | acctid                 | Integer          | Account ID
}}{{TableRowN| &nbsp;                  | session                | Integer          | Session ID
}}{{TableRowN| &nbsp;                  | request_type           | String           | "read"
}}{{TableRowN| ''<parent>''            | account            | Array of Objects | The accounts object
}}{{TableEnd}}

'''JSON Mode Response Properties'''
{{TableStart|border_size=1
}}{{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| 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          | resource            | Optional        | String | The resource of the feature            
}}{{TableRowN| feature          | description         | Optional           | String | The description of the feature            
}}{{TableRowN| feature          | resource_id        | Optional            | Integer | The ID of the resource            
}}{{TableRowN| feature          | parent_ids          | Optional          | Array of Integers | The IDs of the parent features           
}}{{TableRowN| feature          | option          | Optional          | String | The value of the feature             
}}{{TableRowN| feature          | is_hidden          | Optional          | Boolean |  Is the feature hidden            
}}{{TableEnd}}

====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'''
{{TableStart|border_size=1
}}{{TableRowN| '''Parent Properties''' | '''Child Properties'''   | '''Type'''       | '''Description'''
}}{{TableRowN| &nbsp;                  | acctid                 | Integer          | Account ID
}}{{TableRowN| &nbsp;                  | session                | Integer          | Session ID
}}{{TableRowN| &nbsp;                  | request_type           | String           | "read"
}}{{TableRowN| ''<parent>''            | account            | Array of Objects | The accounts object
}}{{TableRowN| account             | '''''CHILD PROPERTY''''' | &nbsp;           | Account's child properties to be edited*
}}{{TableEnd}}
<nowiki>*</nowiki>One or more '''account''' child properties listed below is required

'''JSON Mode Response Properties'''
{{TableStart|border_size=1
}}{{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| 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}}