Difference between revisions of "Sensaphone.net API/account"
From Sensaphone.net
(→GET) |
(→Sensaphone.net API) |
||
| Line 9: | Line 9: | ||
}}{{TableRowN| account | name | String | The name of the account | ''' ''' | ''' ''' | '''✓''' | '''✓''' | }}{{TableRowN| account | name | String | The name of the account | ''' ''' | ''' ''' | '''✓''' | '''✓''' | ||
}}{{TableRowN| account | timezone | String | The timezone which the account is in | ''' ''' | ''' ''' | '''✓''' | '''✓''' | }}{{TableRowN| account | timezone | String | The timezone which the account is in | ''' ''' | ''' ''' | '''✓''' | '''✓''' | ||
| − | }}{{TableRowN| account | feature | Object | The feature linked to the account (See [[Sensaphone.net API/feature]]) | ''' ''' | ''' ''' | '''✓''' | '''✓''' | + | }}{{TableRowN| account | feature | Array of Object | The feature linked to the account (See [[Sensaphone.net API/feature]]) | ''' ''' | ''' ''' | '''✓''' | '''✓''' |
}}{{TableEnd}} | }}{{TableEnd}} | ||
Latest revision as of 10:07, 28 May 2015
Sensaphone.net API
Specifications
The account resource
The account resource has the following properties:
| Parent Property | Property | 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 | Array of Object | The feature linked to the account (See Sensaphone.net API/feature) | ✓ | ✓ |
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 | Array of Objects | The feature linked to the account (See Sensaphone.net API/feature) |
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":"John's 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/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 |
