Difference between revisions of "Sensaphone.net API/account"
From Sensaphone.net
(→Sensaphone.net API) |
(→Sensaphone.net API: Update Session data type.) |
||
| Line 27: | Line 27: | ||
}}{{TableRowN| '''Parent Properties''' | '''Child Properties''' | '''Type''' | '''Description''' | }}{{TableRowN| '''Parent Properties''' | '''Child Properties''' | '''Type''' | '''Description''' | ||
}}{{TableRowN| | acctid | Integer | Account ID | }}{{TableRowN| | acctid | Integer | Account ID | ||
| − | }}{{TableRowN| | session | | + | }}{{TableRowN| | session | String | Session Token |
}}{{TableRowN| | request_type | String | "read" | }}{{TableRowN| | request_type | String | "read" | ||
}}{{TableRowN| ''<parent>'' | account | Array of Objects | The accounts object | }}{{TableRowN| ''<parent>'' | account | Array of Objects | The accounts object | ||
| Line 87: | Line 87: | ||
{{TableStart|border_size=1 | {{TableStart|border_size=1 | ||
}}{{TableRowN| '''Parent Properties''' | '''Child Properties''' | '''Type''' | '''Description''' | }}{{TableRowN| '''Parent Properties''' | '''Child Properties''' | '''Type''' | '''Description''' | ||
| − | }}{{TableRowN| | acctid | + | }}{{TableRowN| | acctid | Integer | Account ID |
| − | }}{{TableRowN| | session | + | }}{{TableRowN| | session | String | Session Token |
| − | }}{{TableRowN| | request_type | + | }}{{TableRowN| | request_type | String | "read" |
| − | }}{{TableRowN| ''<parent>'' | account | + | }}{{TableRowN| ''<parent>'' | account | Array of Objects | The accounts object |
| − | }}{{TableRowN| account | + | }}{{TableRowN| account | '''''CHILD PROPERTY''''' | | Account's child properties to be edited* |
}}{{TableEnd}} | }}{{TableEnd}} | ||
<nowiki>*</nowiki>One or more '''account''' child properties listed below is required | <nowiki>*</nowiki>One or more '''account''' child properties listed below is required | ||
| Line 99: | Line 99: | ||
}}{{TableRowN| '''Parent Properties''' | '''Child Property''' | '''Status''' | '''Type''' | '''Description''' | }}{{TableRowN| '''Parent Properties''' | '''Child Property''' | '''Status''' | '''Type''' | '''Description''' | ||
}}{{TableRowN| | ''<parent object(s)>'' | Optional | Array of Objects | The parent(s) specified in the request. | }}{{TableRowN| | ''<parent object(s)>'' | Optional | Array of Objects | The parent(s) specified in the request. | ||
| − | }}{{TableRowN| ''<parent>'' | account | + | }}{{TableRowN| ''<parent>'' | account | Required | Array of Objects | Account Data |
| − | }}{{TableRowN| account | + | }}{{TableRowN| account | name | Optional | String | The name of the account |
| − | }}{{TableRowN| account | + | }}{{TableRowN| account | timezone | Optional | String | The timezone which the account is in |
}}{{TableEnd}} | }}{{TableEnd}} | ||
Latest revision as of 11:31, 10 July 2025
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 | String | Session Token | |
| 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 | String | Session Token | |
| 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 |
