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

2025-07-10T15:44:09Z

‎Sensaphone.net API: Update Session data type.

Tim: /* GET */

2015-05-01T12:39:23Z

‎GET

Tim: Created page with "=Sensaphone.net API= The contactgroup object contains groupings of '''contacts''' and '''users''' (and thus the..."

2015-04-29T19:23:39Z

Created page with "=Sensaphone.net API= The contactgroup object contains groupings of '''contacts''' and '''users''' (and thus the..."

New page

=[[Sensaphone.net API]]=
The contactgroup object contains groupings of '''[[Sensaphone.net API/contact|contacts]]''' and '''[[Sensaphone.net API/user|users]]''' (and thus the contacts that they contain).

==Specifications==
contactgroups are both top level resources (accessed directly) and are contained as part of the alarm delivery targets contained in [[Sensaphone.net API/alarmschedule|alarm schedules]]. All groups can be manipulated directly by their ID, regardless of whether or not they are contained in other resources.

For example, say a contactgroup is part of an alarm schedule. If you "delete" the contactgroup as part of the alarm schedule (<nowiki>https://</nowiki>rest.sensaphone.net/api/v1/alarmschedule/.../contactgroup/), this would only remove it from the schedule. If you "delete" the contactgroup directly, it will remove all instances of it from every resource it is used in.

The contact group resource has the following properties:
{{TableStart|border_size=1
}}{{TableRowN| '''Parent Property''' | '''Property''' | '''Type''' | '''Description''' | '''Create''' | '''Delete''' | '''Read''' | '''Update'''
}}{{TableRowN| ''<parent>'' | contactgroup | Object | The contactgroup object. | '''✓''' | '''✓''' | '''✓''' | '''n/a'''
}}{{TableRowN| contactgroup | group_id | Integer | ID of the contact group. | ''' ''' | ''' ''' | '''✓''' | ''' '''
}}{{TableRowN| contactgroup | name | String | The name of this group. | ''' ''' | ''' ''' | '''✓''' | '''✓'''
}}{{TableRowN| contactgroup | contacts | Array of Objects | The list of contacts in this group. | '''✓''' | ''' ''' | '''✓''' | ''' '''
}}{{TableRowN| contacts | contact_id | Integer | The contact_id of a [[Sensaphone.net API/contact|contact]] that is a member of this group. | '''✓''' | ''' ''' | '''✓''' | ''' '''
}}{{TableRowN| contactgroup | users | Array of Objects | The list of groups in this group. | '''✓''' | ''' ''' | '''✓''' | ''' '''
}}{{TableRowN| users | user_id | Integer | The user_id of a [[Sensaphone.net API/user|user]] that is a member of this group. | '''✓''' | ''' ''' | '''✓''' | ''' '''
}}{{TableEnd}}

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

*Receive all Contact IDs in a given Contact Group
'''GET''' <nowiki>https://</nowiki>rest.sensaphone.net/api/v1/{ACCTID}/{SESSIONID}/contactgroup/{GROUP_ID}/contacts/contact_id

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

'''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|   | contactgroup | Array of Objects | The contactgroup object.
}}{{TableEnd}}

'''JSON Mode Response Properties'''
{{TableStart|border_size=1
}}{{TableRowN| '''Parent Property''' |'''Child Property'''|'''Status'''| '''Type''' | '''Description'''
}}{{TableRowN|   | contactgroup | Required | Array of Objects | The parent device object.
}}{{TableRowN| contactgroup | group_id | Optional | Integer | ID of Device
}}{{TableRowN| contactgroup | name | Optional | String | The name of this group.
}}{{TableRowN| contactgroup | contacts | Optional | Array of Objects | The list of contacts in this group.
}}{{TableRowN| contacts | contact_id | Optional | Integer | The contact_id of a [[Sensaphone.net API/contact|contact]] that is a member of this group.
}}{{TableRowN| contactgroup | users | Optional | Array of Objects | The list of users in this group.
}}{{TableRowN| users | user_id | Optional | Integer | The user_id of a [[Sensaphone.net API/user|user]] that is a member of this group.
}}{{TableEnd}}

====Example JSON====
Receive all Contact Group information

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

*'''Response JSON:'''
{
"result":
{
"success": true,
"code: 0,
"message": "OK",
}
"response":
{
"contactgroup":[
{
"group_id": 6575,
"name": "Night Crew",
"users":
[
{ "user_id": 1234 },
{ "user_id": 1235 }
],
"contacts":
[
{ "contact_id": 8575 },
{ "contact_id": 8404 }
]
},
{
"group_id": 6596,
"name": "Day Crew",
"users":
[
{ "user_id": 1433 },
{ "user_id": 1531 }
],
"contacts":
[
{ "contact_id": 7523 },
{ "contact_id": 6811 }
]
}
]
}
}

===PUT===
The '''PUT''' request for the contact group resource is used to edit the group:
* Change the name

'''URI Mode Response URI:'''
*Edit a the group name
'''PUT''' <nowiki>https://</nowiki>rest.sensaphone.net/api/v1/{ACCTID}/{SESSIONID}/contactgroup/{GROUP_ID}/name/{GROUP_NAME}

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

'''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|   | contactgroup | Array of Objects | The contactgroup object.
}}{{TableRowN| contactgroup | group_id | Integer | ID of Device
}}{{TableRowN| contactgroup | '''''CHILD PROPERTY''''' |   | Child properties to be edited *
}}{{TableEnd}}
<nowiki>*</nowiki> One or more '''contactgroup''' child properties listed below are required in addition to "group_id".

'''JSON Mode Response Properties'''
{{TableStart|border_size=1
}}{{TableRowN| '''Parent Property'''|'''Child Property'''|'''Status'''| '''Type''' | '''Description'''
}}{{TableRowN|   | contactgroup | Required | Array of Objects | The parent device object.
}}{{TableRowN| contactgroup | group_id | Optional | Integer | ID of Device
}}{{TableRowN| contactgroup | name | Optional | String | The name of this group.
}}{{TableRowN| contactgroup | contacts | Optional | Array of Objects | The list of contacts in this group.
}}{{TableRowN| contacts | contact_id | Optional | Integer | The contact_id of a [[Sensaphone.net API/contact|contact]] that is a member of this group.
}}{{TableRowN| contactgroup | users | Optional | Array of Objects | The list of users in this group.
}}{{TableRowN| users | user_id | Optional | Integer | The user_id of a [[Sensaphone.net API/user|user]] that is a member of this group.
}}{{TableEnd}}

===POST===
The preferred method to create a new Contact Group is to use the JSON Mode Request. If the URI Mode Request is used you will be adding a Contact Group with only the '''group_name''' value, all other values will be left empty until separate POST requests are used. With the JSON Mode Request you can create a Contact Group with all values defined in one step.

'''URI Mode Response URI's:'''
*Create a new Contact Group
:'''Note:''' A '''group_name''' is required when creating a new Contact Group.
'''POST''' <nowiki>https://</nowiki>rest.sensaphone.net/api/v1/{ACCTID}/{SESSIONID}/contactgroup/name/{GROUP_NAME}

*Add an existing user to a Contact Group
:'''Note:''' The '''user_id''' used should be the one received in a [[Sensaphone.net API/user|user]] resource GET response.
'''POST''' <nowiki>https://</nowiki>rest.sensaphone.net/api/v1/{ACCTID}/{SESSIONID}/contactgroup/{GROUP_ID}/users/user_id/{USER_ID}

*Add an existing contact to Contact Group
:'''Note:''' The '''contact_id''' used should be the one received in a [[Sensaphone.net API/contact|contact]] resource GET response.
'''POST''' <nowiki>https://</nowiki>rest.sensaphone.net/api/v1/{ACCTID}/{SESSIONID}/contactgroup/{GROUP_ID}/contacts/contact_id/{CONTACT_ID}

'''JSON Mode Request URI:'''
'''POST''' <nowiki>https://</nowiki>rest.sensaphone.net/api/v1/{ACCTID}/{SESSIONID}/contactgroup

'''JSON Mode Request Properties'''
:''Create new contact 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|   | contactgroup | Array of Objects | The contactgroup object.
}}{{TableRowN| contactgroup | name | String | The name of this group.
}}{{TableEnd}}

: ''Add user or contact''
:{{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|   | contactgroup | Array of Objects | The contactgroup object.
}}{{TableRowN| contactgroup | group_id | Integer | ID of Device
}}{{TableRowN| contactgroup | contacts | Array of Objects | The list of contacts in this group.
}}{{TableRowN| contacts | contact_id | Integer | The contact_id of a [[Sensaphone.net API/contact|contact]] that is a member of this group.
}}{{TableRowN| contactgroup | users | Array of Objects | The list of users in this group.
}}{{TableRowN| users | user_id | Integer | The user_id of a [[Sensaphone.net API/user|user]] that is a member of this group.
}}{{TableEnd}}

'''JSON Mode Response Properties'''
:{{TableStart|border_size=1
}}{{TableRowN| '''Parent Property''' |'''Child Property'''|'''Status'''| '''Type''' | '''Description'''
}}{{TableRowN|   | contactgroup | Required | Array of Objects | The parent device object.
}}{{TableRowN| contactgroup | group_id | Optional | Integer | ID of Device
}}{{TableRowN| contactgroup | name | Optional | String | The name of this group.
}}{{TableRowN| contactgroup | contacts | Optional | Array of Objects | The list of contacts in this group.
}}{{TableRowN| contacts | contact_id | Optional | Integer | The contact_id of a [[Sensaphone.net API/contact|contact]] that is a member of this group.
}}{{TableRowN| contactgroup | users | Optional | Array of Objects | The list of users in this group.
}}{{TableRowN| users | user_id | Optional | Integer | The user_id of a [[Sensaphone.net API/user|user]] that is a member of this group.
}}{{TableEnd}}

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

*Delete a user from a Contact Group
'''DELETE''' <nowiki>https://</nowiki>rest.sensaphone.net/api/v1/{ACCTID}/{SESSIONID}/contactgroup/{GROUP_ID}/users/user_id/{USER_ID}

*Delete a contact from a Contact Group
'''DELETE''' <nowiki>https://</nowiki>rest.sensaphone.net/api/v1/{ACCTID}/{SESSIONID}/contactgroup/{GROUP_ID}/contacts/contact_id/{CONTACT_ID}

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

'''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| contactgroup | group_id | Integer | ID of Device
}}{{TableRowN| contactgroup | contacts | Array of Objects | The list of contacts in this group.
}}{{TableRowN| contacts | contact_id | Integer | The contact_id of a [[Sensaphone.net API/contact|contact]] that is a member of this group.
}}{{TableRowN| contactgroup | users | Array of Objects | The list of users in this group.
}}{{TableRowN| users | user_id | Integer | The user_id of a [[Sensaphone.net API/user|user]] 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;          | contactgroup             | Array of Objects | The contactgroup object.
@@ Line 120: / Line 120: @@
 }}{{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;          | contactgroup             | Array of Objects | The contactgroup object.
@@ Line 164: / Line 164: @@
 }}{{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;          | contactgroup             | Array of Objects | The contactgroup object.
@@ Line 174: / Line 174: @@
 }}{{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;          | contactgroup             | Array of Objects | The contactgroup object.
@@ Line 214: / Line 214: @@
 }}{{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.

@@ Line 25: / Line 25: @@
 *Receive all Contact IDs in a given Contact Group
-    '''GET''' <nowiki>https://</nowiki>rest.sensaphone.net/api/v1/{ACCTID}/{SESSIONID}/contactgroup/{GROUP_ID}/contacts/contact_id
+    '''GET''' <nowiki>https://</nowiki>rest.sensaphone.net/api/v1/{ACCTID}/{SESSIONID}/contactgroup/{GROUP_ID}/contacts/
 '''JSON Mode Response URI:'''

Sensaphone.net API/contactgroup - Revision history

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

Tim: /* GET */

Tim: Created page with "=Sensaphone.net API= The contactgroup object contains groupings of '''contacts''' and '''users''' (and thus the..."