Sensaphone.net API/account

From Sensaphone.net
Revision as of 09:06, 28 May 2015 by Tim (Talk | contribs) (Example JSON)

Jump to: navigation, search

Sensaphone.net API

Specifications

The account resource

The account resource has the following properties:

Parent PropertyProperty Type Description Create Delete Read Update
<parent> account Object The account object. n/a
account name String The name of the account
account timezone String The timezone which the account is in
account feature Object The feature linked to the account

GET

URI Mode Request URI's:

  • Retrieve all the account data
  GET https://rest.sensaphone.net/api/v1/{ACCTID}/{SESSIONID}/account
  • Retrieve the account name
  GET https://rest.sensaphone.net/api/v1/{ACCTID}/{SESSIONID}/account/name

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> account Array of Objects The accounts 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> 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 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 the account name and timezone

  • Request JSON:
{
  "acctid": 987654,
  "sessionid": "0123-4567-8901",
  "request_type": "read",
  "account": [
     {
         "name" : null,
         "timezone" : 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