Sensaphone.net API/account

2015-05-28T15:05:45Z

Tim: /* PUT */

=[[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. | ''' ''' | ''' ''' | '''✓''' | '''n/a'''
}}{{TableRowN| account | name | String | The name of the account | ''' ''' | ''' ''' | '''✓''' | '''✓'''
}}{{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]]) | ''' ''' | ''' ''' | '''✓''' | '''✓'''
}}{{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|   | acctid | Integer | Account ID
}}{{TableRowN|   | session | Integer | Session ID
}}{{TableRowN|   | 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|   | ''<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 (See [[Sensaphone.net API/feature]])
}}{{TableEnd}}

====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'''
{{TableStart|border_size=1
}}{{TableRowN| '''Parent Properties''' | '''Child Properties''' | '''Type''' | '''Description'''
}}{{TableRowN|   | acctid | Integer | Account ID
}}{{TableRowN|   | session | Integer | Session ID
}}{{TableRowN|   | request_type | String | "read"
}}{{TableRowN| ''<parent>'' | account | Array of Objects | The accounts object
}}{{TableRowN| account | '''''CHILD PROPERTY''''' |   | 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|   | ''<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
}}{{TableEnd}}

Sensaphone.net API/account

2015-05-28T15:05:17Z

Tim: /* PUT */

=[[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. | ''' ''' | ''' ''' | '''✓''' | '''n/a'''
}}{{TableRowN| account | name | String | The name of the account | ''' ''' | ''' ''' | '''✓''' | '''✓'''
}}{{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]]) | ''' ''' | ''' ''' | '''✓''' | '''✓'''
}}{{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|   | acctid | Integer | Account ID
}}{{TableRowN|   | session | Integer | Session ID
}}{{TableRowN|   | 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|   | ''<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 (See [[Sensaphone.net API/feature]])
}}{{TableEnd}}

====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'''
{{TableStart|border_size=1
}}{{TableRowN| '''Parent Properties''' | '''Child Properties''' | '''Type''' | '''Description'''
}}{{TableRowN|   | acctid | Integer | Account ID
}}{{TableRowN|   | session | Integer | Session ID
}}{{TableRowN|   | request_type | String | "read"
}}{{TableRowN| ''<parent>'' | account | Array of Objects | The accounts object
}}{{TableRowN| account | '''''CHILD PROPERTY''''' |   | 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|   | ''<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}}