Mwood: /* Sensaphone.net API */ Update Session data type.

2025-07-10T15:35:31Z

‎Sensaphone.net API: Update Session data type.

Tim: Created page with "=Sensaphone.net API= Sensaphone.net includes a feature to group individual devices together. The DeviceGroup API allows a user to view and edit grouping information. ==S..."

2015-04-29T19:12:01Z

Created page with "=Sensaphone.net API= Sensaphone.net includes a feature to group individual devices together. The DeviceGroup API allows a user to view and edit grouping information. ==S..."

New page

=[[Sensaphone.net API]]=
Sensaphone.net includes a feature to group individual devices together. The DeviceGroup API allows a user to view and edit grouping information.

==Specifications==

The device group resource has the following properties:
{{TableStart|border_size=1
}}{{TableRowN| '''Parent Property''' | '''Property''' | '''Type''' | '''Description''' | '''Create''' | '''Delete''' | '''Read''' | '''Update'''
}}{{TableRowN| ''<parent>'' | devicegroup | Object | The devicegroup object. | '''✓''' | '''✓''' | '''✓''' | '''n/a'''
}}{{TableRowN| devicegroup | group_id | Integer | ID of the device group. | ''' ''' | ''' ''' | '''✓''' | ''' '''
}}{{TableRowN| devicegroup | name | String | The name of this group. | ''' ''' | ''' ''' | '''✓''' | '''✓'''
}}{{TableRowN| devicegroup | devices | Array of Objects | The list of devices in this group. | '''✓''' | ''' ''' | '''✓''' | ''' '''
}}{{TableRowN| devices | device_id | Integer | The device_id of a device that is a member of this group. | '''✓''' | ''' ''' | '''✓''' | ''' '''
}}{{TableRowN| devicegroup | groups | Array of Objects | The list of groups in this group. | '''✓''' | ''' ''' | '''✓''' | ''' '''
}}{{TableRowN| groups | group_id | Integer | The group_id of a group that is a member of this group. | '''✓''' | ''' ''' | '''✓''' | ''' '''
}}{{TableEnd}}

===GET===
'''URI Mode Request URI's:'''
*Receive all Device Group information
'''GET''' <nowiki>https://</nowiki>rest.sensaphone.net/api/v1/{ACCTID}/{SESSIONID}/devicegroup

*Receive all Device Group names
'''GET''' <nowiki>https://</nowiki>rest.sensaphone.net/api/v1/{ACCTID}/{SESSIONID}/devicegroup/name

*Receive all Device ID's in a Device Group
'''GET''' <nowiki>https://</nowiki>rest.sensaphone.net/api/v1/{ACCTID}/{SESSIONID}/devicegroup/{GROUP_ID}/devices/device_id

'''JSON Mode Request URI:'''
'''POST''' <nowiki>https://</nowiki>rest.sensaphone.net/api/v1/devicegroup

'''JSON Mode Request Properties'''
{{TableStart|border_size=1
}}{{TableRowN| '''Parent Property'''|'''Child Property''' |'''Type''' | '''Description'''
}}{{TableRowN|   | acctid | Integer | Account ID
}}{{TableRowN|   | session | Integer | Session ID
}}{{TableRowN|   | request_type | String | "read"
}}{{TableRowN|   | devicegroup | Array of Objects | The devicegroup object.
}}{{TableEnd}}

'''JSON Mode Response Properties'''
{{TableStart|border_size=1
}}{{TableRowN| '''Parent Property''' |'''Child Property'''|'''Status'''| '''Type''' | '''Description'''
}}{{TableRowN|   | devicegroup | Required | Array of Objects | The parent device object.
}}{{TableRowN| devicegroup | group_id | Optional | Integer | ID of Device Group
}}{{TableRowN| devicegroup | name | Optional | String | The name of this group.
}}{{TableRowN| devicegroup | devices | Optional | Array of Objects | The list of devices in this group.
}}{{TableRowN| devices | device_id | Optional | Integer | The device_id of a device that is a member of this group.
}}{{TableRowN| devicegroup | groups | Optional | Array of Objects | The list of groups in this group.
}}{{TableRowN| groups | group_id | Optional | Integer | The group_id of a group that is a member of this group.
}}{{TableEnd}}

====Example JSON====
Receive all Device Group information

*'''Request JSON:'''
{
"acctid": 987654,
"session": "0123-4567-8901",
"request_type": "read",
"devicegroup": null
}

*'''Response JSON:'''
{
"result":
{
"success": true,
"code: 0,
"message": "OK",
}
"response":
{
"devicegroup":[
{
"group_id": 6575,
"name": "South Barns",
"devices":
[
{ "device_id": 1234 },
{ "device_id": 1235 }
],
"groups":
[
{ "group_id": 8575 },
{ "group_id": 8404 }
]
}
]
}
}

===PUT===
The '''PUT''' request for the device group resource is used to edit the group:
*Change the name
*Add or remove devices (JSON mode only)
*Add or remove groups (JSON mode only)

'''URI Mode Request URI:'''
*Edit a Device Group '''name'''
'''PUT''' <nowiki>https://</nowiki>rest.sensaphone.net/api/v1/{ACCTID}/{SESSIONID}/devicegroup/{GROUP_ID}/name/{GROUP_NAME}

'''JSON Mode Request URI:'''
'''POST''' <nowiki>https://</nowiki>rest.sensaphone.net/api/v1/devicegroup

'''JSON Mode Request Properties'''
{{TableStart|border_size=1
}}{{TableRowN| '''Parent Property'''|'''Child Property''' |'''Type''' | '''Description'''
}}{{TableRowN|   | acctid | Integer | Account ID
}}{{TableRowN|   | session | Integer | Session ID
}}{{TableRowN|   | request_type | String | "update"
}}{{TableRowN|   | devicegroup | Array of Objects | The devicegroup object.
}}{{TableRowN| devicegroup | group_id | Integer | ID of the device group.
}}{{TableRowN| devicegroup | group_name | String | New name of a Device Group
}}{{TableEnd}}

'''JSON Mode Response Properties'''
{{TableStart|border_size=1
}}{{TableRowN| '''Parent Property''' |'''Child Property'''|'''Status'''| '''Type''' | '''Description'''
}}{{TableRowN|   | devicegroup | Required | Array of Objects | The parent device object.
}}{{TableRowN| devicegroup | group_id | Optional | Integer | ID of Device
}}{{TableRowN| devicegroup | name | Optional | String | The name of this group.
}}{{TableRowN| devicegroup | devices | Optional | Array of Objects | The list of devices in this group.
}}{{TableRowN| devices | device_id | Optional | Integer | The device_id of a device that is a member of this group.
}}{{TableRowN| devicegroup | groups | Optional | Array of Objects | The list of groups in this group.
}}{{TableRowN| groups | group_id | Optional | Integer | The group_id of a group that is a member of this group.
}}{{TableEnd}}

===POST===
'''URI Mode Request URI's:'''
*Create a new empty Device Group (A '''group_name''' value is required when creating a new Device Group)
'''POST''' <nowiki>https://</nowiki>rest.sensaphone.net/api/v1/{ACCTID}/{SESSIONID}/devicegroup/name/{GROUP_NAME}

*Add a device to a device group
'''POST''' <nowiki>https://</nowiki>rest.sensaphone.net/api/v1/{ACCTID}/{SESSIONID}/devicegroup/{GROUP_ID}/devices/device_id/{DEVICE_ID}

*Add a group to a device group
'''POST''' <nowiki>https://</nowiki>rest.sensaphone.net/api/v1/{ACCTID}/{SESSIONID}/devicegroup/{GROUP_ID}/groups/group_id/{GROUP_ID}

'''JSON Mode Request URI:'''
'''POST''' <nowiki>https://</nowiki>rest.sensaphon.net/api/v1/devicegroups

'''JSON Mode Request Properties'''
:''Create new device group''
:{{TableStart|border_size=1
}}{{TableRowN| '''Parent Property'''|'''Child Property''' |'''Type''' | '''Description'''
}}{{TableRowN|   | acctid | Integer | Account ID
}}{{TableRowN|   | session | Integer | Session ID
}}{{TableRowN|   | request_type | String | "create"
}}{{TableRowN|   | devicegroup | Array of Objects | The devicegroup object.
}}{{TableRowN| devicegroup | name | String | New name of a Device Group.
}}{{TableEnd}}

:''Add device and/or group''
:{{TableStart|border_size=1
}}{{TableRowN| '''Parent Property'''|'''Child Property''' |'''Type''' | '''Description'''
}}{{TableRowN|   | acctid | Integer | Account ID
}}{{TableRowN|   | session | Integer | Session ID
}}{{TableRowN|   | request_type | String | "create"
}}{{TableRowN|   | devicegroup | Array of Objects | The devicegroup object.
}}{{TableRowN| devicegroup | group_id | Integer | ID of Device
}}{{TableRowN| devicegroup | devices | Array of Objects | Used to add devices to the group.
}}{{TableRowN| devices | device_id | Integer | The device_id of a [[Sensaphone.net API/device|device]] to add to this group.
}}{{TableRowN| devicegroup | groups | Array of Object | Used to add groups to the group.
}}{{TableRowN| groups | group_id | Integer | The group_id of a group to add to this group.
}}{{TableEnd}}

'''JSON Mode Response Properties'''
:{{TableStart|border_size=1
}}{{TableRowN| '''Parent Property''' |'''Child Property'''|'''Status'''| '''Type''' | '''Description'''
}}{{TableRowN|   | devicegroup | Required | Array of Objects | The parent device object.
}}{{TableRowN| devicegroup | group_id | Optional | Integer | ID of Device
}}{{TableRowN| devicegroup | name | Optional | String | The name of this group.
}}{{TableRowN| devicegroup | devices | Optional | Array of Objects | The list of devices in this group.
}}{{TableRowN| devices | device_id | Optional | Integer | The device_id of a device that is a member of this group.
}}{{TableRowN| devicegroup | groups | Optional | Array of Objects | The list of groups in this group.
}}{{TableRowN| groups | group_id | Optional | Integer | The group_id of a group that is a member of this group.
}}{{TableEnd}}

===DELETE===
'''URI Mode Request URI's:'''
*Delete a device group
'''DELETE''' <nowiki>https://</nowiki>rest.sensaphone.net/api/v1/{ACCTID}/{SESSIONID}/devicegroup/{GROUP_ID}

*Delete a device from a device group
'''DELETE''' <nowiki>https://</nowiki>rest.sensaphone.net/api/v1/{ACCTID}/{SESSIONID}/devicegroup/{GROUP_ID}/devices/device_id/{DEVICE_ID}

*Delete a group from a device group
'''DELETE''' <nowiki>https://</nowiki>rest.sensaphone.net/api/v1/{ACCTID}/{SESSIONID}/devicegroup/{GROUP_ID}/groups/group_id/{GROUP_ID}

'''JSON Mode Request URI:'''
'''POST''' <nowiki>https://</nowiki>rest.sensaphone.net/api/v1/devicegroup

'''JSON Mode Request Properties'''
{{TableStart|border_size=1
}}{{TableRowN| '''Parent Property'''|'''Child Property''' |'''Type''' | '''Description'''
}}{{TableRowN|   | acctid | Integer | Account ID
}}{{TableRowN|   | session | Integer | Session ID
}}{{TableRowN|   | request_type | String | "delete"
}}{{TableRowN|   | devicegroup | Array of Objects | The devicegroup object.
}}{{TableRowN| devicegroup | group_id | Integer | ID of the device group.
}}{{TableRowN| devicegroup | devices | Array of Objects | Used to remove devices from the group. (Optional)
}}{{TableRowN| devices | device_id | Integer | The device_id of a device that is a member of this group.
}}{{TableRowN| devicegroup | groups | Array of Object | Used to remove groups from the group. (Optional)
}}{{TableRowN| groups | group_id | Integer | The group_id of a group that is a member of this group.
}}{{TableEnd}}

@@ Line 34: / Line 34: @@
 }}{{TableRowN| '''Parent Property'''|'''Child Property''' |'''Type'''        | '''Description'''
 }}{{TableRowN| &nbsp;          | acctid                   | Integer          | Account ID
-}}{{TableRowN| &nbsp;          | session                  | Integer          | Session ID
+}}{{TableRowN| &nbsp;          | session                  | String           | Session Token
 }}{{TableRowN| &nbsp;          | request_type             | String           | "read"
 }}{{TableRowN| &nbsp;          | devicegroup              | Array of Objects | The devicegroup object.
@@ Line 108: / Line 108: @@
 }}{{TableRowN| '''Parent Property'''|'''Child Property''' |'''Type'''        | '''Description'''
 }}{{TableRowN| &nbsp;          | acctid                   | Integer          | Account ID
-}}{{TableRowN| &nbsp;          | session                  | Integer          | Session ID
+}}{{TableRowN| &nbsp;          | session                  | String           | Session Token
 }}{{TableRowN| &nbsp;          | request_type             | String           | "update"
 }}{{TableRowN| &nbsp;          | devicegroup              | Array of Objects | The devicegroup object.
@@ Line 146: / Line 146: @@
 }}{{TableRowN| '''Parent Property'''|'''Child Property''' |'''Type'''        | '''Description'''
 }}{{TableRowN| &nbsp;          | acctid                   | Integer          | Account ID
-}}{{TableRowN| &nbsp;          | session                  | Integer          | Session ID
+}}{{TableRowN| &nbsp;          | session                  | String           | Session Token
 }}{{TableRowN| &nbsp;          | request_type             | String           | "create"
 }}{{TableRowN| &nbsp;          | devicegroup              | Array of Objects | The devicegroup object.
@@ Line 156: / Line 156: @@
 }}{{TableRowN| '''Parent Property'''|'''Child Property''' |'''Type'''        | '''Description'''
 }}{{TableRowN| &nbsp;          | acctid                   | Integer          | Account ID
-}}{{TableRowN| &nbsp;          | session                  | Integer          | Session ID
+}}{{TableRowN| &nbsp;          | session                  | String           | Session Token
 }}{{TableRowN| &nbsp;          | request_type             | String           | "create"
 }}{{TableRowN| &nbsp;          | devicegroup              | Array of Objects | The devicegroup object.
@@ Line 196: / Line 196: @@
 }}{{TableRowN| '''Parent Property'''|'''Child Property''' |'''Type'''        | '''Description'''
 }}{{TableRowN| &nbsp;          | acctid                   | Integer          | Account ID
-}}{{TableRowN| &nbsp;          | session                  | Integer          | Session ID
+}}{{TableRowN| &nbsp;          | session                  | String           | Session Token
 }}{{TableRowN| &nbsp;          | request_type             | String           | "delete"
 }}{{TableRowN| &nbsp;          | devicegroup              | Array of Objects | The devicegroup object.

Sensaphone.net API/devicegroup - Revision history

Mwood: /* Sensaphone.net API */ Update Session data type.

Tim: Created page with "=Sensaphone.net API= Sensaphone.net includes a feature to group individual devices together. The DeviceGroup API allows a user to view and edit grouping information. ==S..."