Sensaphone.net API/contact - Revision history

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

2025-07-10T15:46:25Z

‎Sensaphone.net API: Update Session data type.

Tim: /* POST */

2015-05-01T12:35:25Z

‎POST

Tim: /* PUT */

2015-05-01T12:34:58Z

‎PUT

Tim: /* Example JSON */

2015-05-01T12:34:15Z

‎Example JSON

Tim: /* GET */

2015-05-01T12:32:02Z

‎GET

Tim: /* DELETE */

2015-05-01T12:31:12Z

‎DELETE

Tim: /* POST */

2015-05-01T12:30:47Z

‎POST

Tim: /* PUT */

2015-05-01T12:30:17Z

‎PUT

Tim: /* GET */

2015-05-01T12:29:57Z

‎GET

Tim: /* GET */

2015-05-01T12:29:26Z

‎GET

@@ Line 33: / Line 33: @@
 }}{{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;          | ''<parent object(s)>''   | Array of Objects | The parent(s) of the "contact" resource, if any. See the [[Sensaphone.net_API#List|'''list''']].
@@ Line 141: / Line 141: @@
 }}{{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;          | ''<parent object(s)>''   | Array of Objects | The parent(s) of the "contact" resource, if any. See the [[Sensaphone.net_API#List|'''list''']].
@@ Line 179: / Line 179: @@
 }}{{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;          | ''<parent object(s)>''   | Array of Objects | The parent(s) of the "contact" resource, if any. See the [[Sensaphone.net_API#List|'''list''']].
@@ Line 213: / Line 213: @@
 }}{{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;          | ''<parent object(s)>''   | Array of Objects | The parent(s) of the "contact" resource, if any. See the [[Sensaphone.net_API#List|'''list''']].

@@ Line 173: / Line 173: @@
 '''JSON Mode Request URI:'''
-    '''POST''' <nowiki>https://</nowiki>rest.sensaphone.net/api/v1/user/contact
+    '''POST''' <nowiki>https://</nowiki>rest.sensaphone.net/api/v1/user/alarm_user/contact
 '''JSON Mode Request Properties'''

@@ Line 135: / Line 135: @@
 '''JSON Mode Request URI:'''
-    '''POST''' <nowiki>https://</nowiki>rest.sensaphone.net/api/v1/user/contact
+    '''POST''' <nowiki>https://</nowiki>rest.sensaphone.net/api/v1/user/alarm_user/contact
 '''JSON Mode Request Properties'''

@@ Line 60: / Line 60: @@
        "session":"0123-4567-8901",
        "request_type":"read",
-       "user": [                  &#8592; "user" is a parent object
+       "user": [ {                  &#8592; "user" is a parent object
          "user_id":395,
-         "contact": null          &#8592; On a "read", a null property can be used to retrieve all instances of that property.
+         "alarm_user" : {
+          "contact": null          &#8592; On a "read", a null property can be used to retrieve all instances of that property.
+    }

@@ Line 27: / Line 27: @@
 '''JSON Mode Request URI:'''
-    '''POST''' <nowiki>https://</nowiki>rest.sensaphone.net/api/v1/user/contact
+    '''POST''' <nowiki>https://</nowiki>rest.sensaphone.net/api/v1/user/alarm_user/contact
 '''JSON Mode Request Properties'''

@@ Line 166: / Line 166: @@
 '''URI Mode Request URI:'''
 *Create a new user dependent contact.
-    '''POST''' <nowiki>https://</nowiki>rest.sensaphone.net/api/v1/{ACCTID}/{SESSIONID}/user/{USER_ID}/contact/destination/{DESTINATION}
+    '''POST''' <nowiki>https://</nowiki>rest.sensaphone.net/api/v1/{ACCTID}/{SESSIONID}/user/{USER_ID}/alarm_user/contact/destination/{DESTINATION}
 *Create a new user independent contact.
     '''POST''' <nowiki>https://</nowiki>rest.sensaphone.net/api/v1/{ACCTID}/{SESSIONID}/contact/destination/{DESTINATION}

@@ Line 126: / Line 126: @@
 '''URI Mode Request URI's'''
 *Edit the '''description''' of a contact
-    '''PUT''' <nowiki>https://</nowiki>rest.sensaphone.net/api/v1/{ACCTID}/{SESSIONID}/user/{USER_ID}/contact/{CONTACT_ID}/description/{DESCRIPTION}
+    '''PUT''' <nowiki>https://</nowiki>rest.sensaphone.net/api/v1/{ACCTID}/{SESSIONID}/user/{USER_ID}/alarm_user/contact/{CONTACT_ID}/description/{DESCRIPTION}
 *Edit the '''destination''' of a contact
-    '''PUT''' <nowiki>https://</nowiki>rest.sensaphone.net/api/v1/{ACCTID}/{SESSIONID}/user/{USER_ID}/contact/{CONTACT_ID}/destination/{DESTINATION}
+    '''PUT''' <nowiki>https://</nowiki>rest.sensaphone.net/api/v1/{ACCTID}/{SESSIONID}/user/{USER_ID}/alarm_user/contact/{CONTACT_ID}/destination/{DESTINATION}
 *Edit the contact's destination '''type'''
-    '''PUT''' <nowiki>https://</nowiki>rest.sensaphone.net/api/v1/{ACCTID}/{SESSIONID}/user/{USER_ID}/contact/{CONTACT_ID}/type/{TYPE}
+    '''PUT''' <nowiki>https://</nowiki>rest.sensaphone.net/api/v1/{ACCTID}/{SESSIONID}/user/{USER_ID}/alarm_user/contact/{CONTACT_ID}/type/{TYPE}
 '''JSON Mode Request URI:'''

@@ Line 20: / Line 20: @@
 '''URI Mode Request URI's:'''
 *Retrieve all information for all of a user's contacts.
-    '''GET''' <nowiki>https://</nowiki>rest.sensaphone.net/api/v1/{ACCTID}/{SESSIONID}/user/alarm_user/{USER_ID}/contact
+    '''GET''' <nowiki>https://</nowiki>rest.sensaphone.net/api/v1/{ACCTID}/{SESSIONID}/user/{USER_ID}/alarm_user/contact
 *Retrieve the description of a specific user's contact.
-    '''GET''' <nowiki>https://</nowiki>rest.sensaphone.net/api/v1/{ACCTID}/{SESSIONID}/user/alarm_user/{USER_ID}/contact/{CONTACT_ID}/description
+    '''GET''' <nowiki>https://</nowiki>rest.sensaphone.net/api/v1/{ACCTID}/{SESSIONID}/user/{USER_ID}/alarm_user/contact/{CONTACT_ID}/description
 *Retrieve all of the contact IDs for a particular user's contacts.
-    '''GET''' <nowiki>https://</nowiki>rest.sensaphone.net/api/v1/{ACCTID}/{SESSIONID}/user/alarm_user/{USER_ID}/contact/contact_id
+    '''GET''' <nowiki>https://</nowiki>rest.sensaphone.net/api/v1/{ACCTID}/{SESSIONID}/user/{USER_ID}/alarm_user/contact/contact_id
 '''JSON Mode Request URI:'''