Difference between revisions of "Sensaphone.net API/feature"
From Sensaphone.net
(→Specifications) |
(→GET) |
||
| Line 25: | Line 25: | ||
'''JSON Mode Request URI:''' | '''JSON Mode Request URI:''' | ||
| − | '''POST''' <nowiki>https://</nowiki>rest.sensaphone.net/api/v1/account | + | '''POST''' <nowiki>https://</nowiki>rest.sensaphone.net/api/v1/account/feature |
'''JSON Mode Request Properties''' | '''JSON Mode Request Properties''' | ||
Revision as of 09:04, 28 May 2015
Sensaphone.net API
Specifications
The feature resource
The feature resource has the following properties:
| Parent Property | Property | 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/feature
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 |
