Sensaphone.net API/user - Revision history

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

2025-07-10T15:45:17Z

‎Sensaphone.net API: Update Session data type.

Tim: /* Example JSON */

2015-05-01T12:38:01Z

‎Example JSON

Tim: /* POST */

2015-05-01T12:37:24Z

‎POST

Tim: /* Sensaphone.net API */

2015-04-30T19:20:53Z

‎Sensaphone.net API

Tim: /* Specifications */

2015-04-30T19:19:14Z

‎Specifications

Tim: /* Specifications */

2015-04-30T19:18:49Z

‎Specifications

Tim: /* Sensaphone.net API */

2015-04-30T19:16:44Z

‎Sensaphone.net API

Tim: /* Specifications */

2015-04-30T19:15:21Z

‎Specifications

Tim: Created page with "=Sensaphone.net API= ==Specifications== The '''user''' resource allows access to information relating to two classes of persons: those who will have access to the websit..."

2015-04-29T19:24:08Z

Created page with "=Sensaphone.net API= ==Specifications== The '''user''' resource allows access to information relating to two classes of persons: those who will have access to the websit..."

New page

=[[Sensaphone.net API]]=

==Specifications==
The '''user''' resource allows access to information relating to two classes of persons: those who will have access to the website and API and those who will be notified in the event of an alarms. A user may be in one, both, or neither class.

The user resource has the following properties:
{{TableStart|border_size=1
}}{{TableRowN| '''Parent Property''' |'''Property''' | '''Type''' | '''Description''' | '''Create''' | '''Delete''' | '''Read''' | '''Update'''
}}{{TableRowN| ''<parent>'' | user | Object | The user object. | '''✓''' | '''✓''' | '''✓''' | '''n/a'''
}}{{TableRowN| user | user_id | Integer | ID of the user. | ''' ''' | ''' ''' | '''✓''' | ''' '''
}}{{TableRowN| user | name | String | Name of user. | ''' ''' | ''' ''' | '''✓''' | '''✓'''
}}{{TableRowN| user | enable | Boolean | If the user is enabled. | ''' ''' | ''' ''' | '''✓''' | '''✓'''
}}{{TableRowN| user | alarm_user_mode | String | The alarm user mode | ''' ''' | ''' ''' | '''✓''' | '''✓'''
}}{{TableRowN| user | is_site_user | Boolean | If the user has site access (website or API) | '''✓''' | ''' ''' | '''✓''' | ''' '''
}}{{TableRowN| user | site_user | Object | sub-object contains data for where is_site_user is 'true'. Is still accessed using the "user" resource | ''' ''' | ''' ''' | '''✓''' | '''✓'''
}}{{TableRowN| site_user | devices | Array of String | List of devices (device_guid) accessible by this user. | '''✓''' | ''' ''' | '''✓''' | ''' '''
}}{{TableRowN| site_user | groups | Array of Integer | group IDs of the groups accessible by this user. | '''✓''' | ''' ''' | '''✓''' | ''' '''
}}{{TableRowN| site_user | username | String | The username to access the website or API | ''' ''' | ''' ''' | '''✓''' | '''✓'''
}}{{TableRowN| site_user | access_level | String | The current access level for website or API access. | ''' ''' | ''' ''' | '''✓''' | '''✓'''
}}{{TableRowN| site_user | address | Object | (See [[Sensaphone.net API/address|Sensaphone.net API/address]]) | ''' ''' | ''' ''' | '''✓''' | '''✓'''
}}{{TableRowN| user | is_alarm_user | Boolean | If the user is enabled for alarm delivery. | '''✓''' | ''' ''' | '''✓''' | '' '''
}}{{TableRowN| user | alarm_user | Object | sub-object contains data for where is_alarm_user is 'true'. Is still accessed using the "user" resource. | ''' ''' | ''' ''' | '''✓''' | '''✓'''
}}{{TableRowN| alarm_user | schedule | Object | (See [[Sensaphone.net API/schedule|Sensaphone.net API/schedule]]) | ''' ''' | ''' ''' | '''✓''' | '''✓'''
}}{{TableRowN| alarm_user | contact | Array of Object | (See [[Sensaphone.net API/contact|Sensaphone.net API/contact]]) | ''' ''' | ''' ''' | '''✓''' | '''✓'''
}}{{TableEnd}}

===GET===
'''URI Request Mode URI's:'''
*Retrieve all user data for all users in the account.
'''GET''' <nowiki>https://</nowiki>rest.sensaphone.net/api/v1/{''ACCTID''}/{''SESSIONID''}/user
*Retrieve all user data for a specific user.
'''GET''' <nowiki>https://</nowiki>rest.sensaphone.net/api/v1/{''ACCTID''}/{''SESSIONID''}/user/{''USER_ID''}
*Retrieve the name of a specific user.
'''GET''' <nowiki>https://</nowiki>rest.sensaphone.net/api/v1/{''ACCTID''}/{''SESSIONID''}/user/{''USER_ID''}/name
'''JSON Request Mode URI:'''
'''POST''' <nowiki>https://</nowiki>rest.sensaphone.net/api/v1/user

'''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|   | ''<parent object(s)>'' | Array of Objects | The parent(s) of the "user" resource, if any. See the [[Sensaphone.net_API#List|'''list''']].
}}{{TableRowN| ''<parent>'' | user | Array of Objects | The user object
}}{{TableEnd}}

'''JSON Mode Response Properties'''
{{TableStart|border_size=1
}}{{TableRowN| '''Parent Property'''|'''Child Property'''|'''Status'''| '''Type''' | '''Description'''
}}{{TableRowN|   | ''<parent object(s)>'' | Optional | Array of Objects | The parent(s) specified in the request.
}}{{TableRowN| ''<parent>'' | user | Required | Array of Objects | The user object
}}{{TableRowN| user | user_id | Optional | Integer | ID of user
}}{{TableRowN| user | name | Optional | String | Name of user
}}{{TableRowN| user | enable | Optional | Boolean | If the user is enabled.
}}{{TableRowN| user | alarm_user_mode | Optional | String | The alarm user mode.
}}{{TableRowN| user | is_site_user | Optional | Boolean | If the user has site access (website or API)
}}{{TableRowN| user | site_user | Optional | Object | sub-object contains data for where is_site_user is 'true'. Is still accessed using the "user" resource.
}}{{TableRowN| site_user | devices | Optional | Array of String | List of devices (device_guid) accessible by this user.
}}{{TableRowN| site_user | groups | Optional | Array of Integer | group IDs of the groups accessible by this user.
}}{{TableRowN| site_user | username | Optional | String | The username to access the website or API
}}{{TableRowN| site_user | access_level | Optional | String | The current access level for website or API access.
}}{{TableRowN| site_user | address | Optional | Object | (See [[Sensaphone.net API/address|Sensaphone.net API/address]])
}}{{TableRowN| user | is_alarm_user | Optional | Boolean | If the user is enabled for alarm delivery.
}}{{TableRowN| user | alarm_user | Optional | Object | sub-object contains data for where is_alarm_user is 'true'. Is still accessed using the "user" resource.
}}{{TableRowN| alarm_user | schedule | Optional | Object | (See [[Sensaphone.net API/schedule|Sensaphone.net API/schedule]])
}}{{TableRowN| alarm_user | contact | Optional | Array of Objects | (See [[Sensaphone.net API/contact|Sensaphone.net API/contact]])
}}{{TableEnd}}

====Example JSON====
Receive all Contact information
* '''Request JSON:'''

{
"request_type":"read",
"resource":"user",
"acctid":987654,
"session":"0123-4567-8901",
"user": null ← On a "read", a null property can be used to retrieve all instances of that property.
}

* '''Response JSON:'''
{
"result":
{
"success":true.
"code":0,
"message":"OK",
},
"response":
{
"user":[
{
"user_id": 1010
"name": "John Doe",
"enable": true,
"is_site_user": true,
"site_user": {
"devices": [
"00-11-22-33-44-55",
"AA-BB-CC-DD-EE-FF"
],
"groups": [
12345,
85693
],
"username": "jdoe@example.net",
"access_level": "Admin",
"address":{
... ← See [[Sensaphone.net API/address|here]] for address object specification
}
},
"is_alarm_user": true,
"alarm_user": {
"schedule":{
... ← See [[Sensaphone.net API/schedule|here]] for schedule object specification
},
"contact":[
{
"contact_id": 1201,
... ← See [[Sensaphone.net API/contact|here]] for contact object specification
},
{
"contact_id": 1202,
...
},
{
"contact_id": 1203,
...
}
]
}
},
{
"user_id": 1023
... ← More than one user is returned because a "null" user was requested.
}
]
}
}

===PUT===
'''URI Mode Request URI's:'''
*Edit a user's '''name''' value
'''PUT''' <nowiki>https://</nowiki>rest.sensaphone.net/api/v1/{ACCTID}/{SESSIONID}/user/{USER_ID}/name/{NAME}
'''JSON Mode Request URI:'''
'''POST''' <nowiki>https://</nowiki>rest.sensaphone.net/api/v1/user

'''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|   | ''<parent object(s)>'' | Array of Objects | The parent(s) of the "user" resource, if any. See the [[Sensaphone.net_API#List|'''list''']].
}}{{TableRowN| ''<parent>'' | user | Array of Objects | The user object
}}{{TableRowN| user | user_id | Integer | ID for user
}}{{TableRowN| user | '''''CHILD PROPERTY''''' |   | User's child properties to be edited*
}}{{TableEnd}}
<nowiki>*</nowiki>One or more '''user''' child properties listed below are required in addition to "user_id".

'''JSON Mode Response Properties'''
{{TableStart|border_size=1
}}{{TableRowN| '''Parent Property'''|'''Child Property'''|'''Status'''| '''Type''' | '''Description'''
}}{{TableRowN|   | ''<parent object(s)>'' | Optional | Array of Objects | The parent(s) specified in the request.
}}{{TableRowN| ''<parent>'' | user | Required | Array of Objects | The user object
}}{{TableRowN| user | user_id | Optional | Integer | ID of user
}}{{TableRowN| user | name | Optional | String | Name of user
}}{{TableRowN| user | enable | Optional | Boolean | If the user is enabled.
}}{{TableRowN| user | alarm_user_mode | Optional | String | The alarm user mode.
}}{{TableRowN| user | is_site_user | Optional | Boolean | If the user has site access (website or API)
}}{{TableRowN| user | site_user | Optional | Object | sub-object contains data for where is_site_user is 'true'. Is still accessed using the "user" resource.
}}{{TableRowN| site_user | devices | Optional | Array of String | List of devices (device_guid) accessible by this user.
}}{{TableRowN| site_user | groups | Optional | Array of Integer | group IDs of the groups accessible by this user.
}}{{TableRowN| site_user | username | Optional | String | The username to access the website or API
}}{{TableRowN| site_user | password | Optional | String | The password to access the website or API
}}{{TableRowN| site_user | access_level | Optional | String | The current access level for website or API access.
}}{{TableRowN| site_user | address | Optional | Object | (See [[Sensaphone.net API/address|Sensaphone.net API/address]])
}}{{TableRowN| user | is_alarm_user | Optional | Boolean | If the user is enabled for alarm delivery.
}}{{TableRowN| user | alarm_user | Optional | Object | sub-object contains data for where is_alarm_user is 'true'. Is still accessed using the "user" resource.
}}{{TableRowN| alarm_user | schedule | Optional | Object | (See [[Sensaphone.net API/schedule|Sensaphone.net API/schedule]])
}}{{TableRowN| alarm_user | contact | Optional | Array of Objects | (See [[Sensaphone.net API/contact|Sensaphone.net API/contact]])
}}{{TableEnd}}

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

'''URI Mode Request URI:'''
*Create a new Contact
'''POST''' <nowiki>https://</nowiki>rest.sensaphone.net/api/v1/{ACCTID}/{SESSIONID}/user/name/{NAME}
'''JSON Mode Request URI'''
'''POST''' <nowiki>https://</nowiki>rest.sensaphone.net/api/v1/user

'''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 | "create"
}}{{TableRowN|   | ''<parent object(s)>'' | Array of Objects | The parent(s) of the "user" resource, if any. See the [[Sensaphone.net_API#List|'''list''']].
}}{{TableRowN| ''<parent>'' | user | Array of Objects | The user object
}}{{TableRowN| user | name | String | Name of user
}}{{TableRowN| user | '''''CHILD PROPERTY''''' |   | Additional child properties to be set*
}}{{TableEnd}}
<nowiki>*</nowiki>One or more '''user''' child properties listed below ''may'' be specified in addition to "user_id" and "name".

'''JSON Mode Response Properties'''
{{TableStart|border_size=1
}}{{TableRowN| '''Parent Property'''|'''Child Property'''|'''Status'''| '''Type''' | '''Description'''
}}{{TableRowN|   | ''<parent object(s)>'' | Optional | Array of Objects | The parent(s) specified in the request.
}}{{TableRowN| ''<parent>'' | user | Required | Array of Objects | The user object
}}{{TableRowN| user | user_id | Optional | Integer | ID of user
}}{{TableRowN| user | name | Optional | String | Name of user
}}{{TableRowN| user | enable | Optional | Boolean | If the user is enabled.
}}{{TableRowN| user | alarm_user_mode | Optional | String | The alarm user mode.
}}{{TableRowN| user | is_site_user | Optional | Boolean | If the user has site access (website or API)
}}{{TableRowN| user | site_user | Optional | Object | sub-object contains data for where is_site_user is 'true'. Is still accessed using the "user" resource.
}}{{TableRowN| site_user | devices | Optional | Array of String | List of devices (device_guid) accessible by this user.
}}{{TableRowN| site_user | groups | Optional | Array of Integer | group IDs of the groups accessible by this user.
}}{{TableRowN| site_user | username | Optional | String | The username to access the website or API
}}{{TableRowN| site_user | password | Optional | String | The password to access the website or API
}}{{TableRowN| site_user | access_level | Optional | String | The current access level for website or API access.
}}{{TableRowN| site_user | address | Optional | Object | (See [[Sensaphone.net API/address|Sensaphone.net API/address]])
}}{{TableRowN| user | is_alarm_user | Optional | Boolean | If the user is enabled for alarm delivery.
}}{{TableRowN| user | alarm_user | Optional | Object | sub-object contains data for where is_alarm_user is 'true'. Is still accessed using the "user" resource.
}}{{TableRowN| alarm_user | schedule | Optional | Object | (See [[Sensaphone.net API/schedule|Sensaphone.net API/schedule]])
}}{{TableRowN| alarm_user | contact | Optional | Array of Objects | (See [[Sensaphone.net API/contact|Sensaphone.net API/contact]])
}}{{TableEnd}}

===DELETE===
'''URI Mode Request URI's:'''
*Delete a User
'''DELETE''' <nowiki>https://</nowiki>rest.sensaphone.net/api/v1/{ACCTID}/{SESSIONID}/user/{USER_ID}

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

'''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|   | ''<parent object(s)>'' | Array of Objects | The parent(s) of the "user" resource, if any. See the [[Sensaphone.net_API#List|'''list''']].
}}{{TableRowN| ''<parent>'' | user | Array of Objects | The user object
}}{{TableRowN| user | user_id | Integer | ID for user
}}{{TableEnd}}

@@ Line 14: / Line 14: @@
 }}{{TableRowN| user                    | alarm_user_mode           | String     | The alarm user mode        | ''' ''' | ''' ''' | '''&#x2713;''' | '''&#x2713;'''
 }}{{TableRowN| user                    | site_user_level           | String     | The site user access level        | ''' ''' | ''' ''' | '''&#x2713;''' | '''&#x2713;'''
-}}{{TableRowN| user                    | is_site_user    | Boolean     | If the user has site access (website or API) | '''&#x2713;''' | ''' ''' | '''&#x2713;''' | ''' '''
+}}{{TableRowN| user                    | is_site_user    | Boolean     | If the user has site access (website or API) | ''' ''' | ''' ''' | '''&#x2713;''' | ''' '''
 }}{{TableRowN| user                    | site_user         | Object    | sub-object contains data for where is_site_user is 'true'. Is still accessed using the "user" resource     | ''' ''' | ''' ''' | '''&#x2713;''' | ''' '''
 }}{{TableRowN| site_user              | devices         | Array of String    | List of devices (device_guid) accessible by this user.     | '''&#x2713;''' | '''&#x2713;''' | '''&#x2713;''' | ''' '''

@@ Line 15: / Line 15: @@
 }}{{TableRowN| user                    | site_user_level           | String     | The site user access level        | ''' ''' | ''' ''' | '''&#x2713;''' | '''&#x2713;'''
 }}{{TableRowN| user                    | is_site_user    | Boolean     | If the user has site access (website or API) | '''&#x2713;''' | ''' ''' | '''&#x2713;''' | ''' '''
-}}{{TableRowN| user                    | site_user         | Object    | sub-object contains data for where is_site_user is 'true'. Is still accessed using the "user" resource     | ''' ''' | ''' ''' | '''&#x2713;''' | '''&#x2713;'''
+}}{{TableRowN| user                    | site_user         | Object    | sub-object contains data for where is_site_user is 'true'. Is still accessed using the "user" resource     | ''' ''' | ''' ''' | '''&#x2713;''' | ''' '''
-}}{{TableRowN| site_user              | devices         | Array of String    | List of devices (device_guid) accessible by this user.     | '''&#x2713;''' | ''' ''' | '''&#x2713;''' | ''' '''
+}}{{TableRowN| site_user              | devices         | Array of String    | List of devices (device_guid) accessible by this user.     | '''&#x2713;''' | '''&#x2713;''' | '''&#x2713;''' | ''' '''
-}}{{TableRowN| site_user              | groups         | Array of Integer    | group IDs of the groups accessible by this user.     | '''&#x2713;''' | ''' ''' | '''&#x2713;''' | ''' '''
+}}{{TableRowN| site_user              | groups         | Array of Integer    | group IDs of the groups accessible by this user.     | '''&#x2713;''' | '''&#x2713;''' | '''&#x2713;''' | ''' '''
 }}{{TableRowN| site_user              | username         | String    | The username to access the website or API     | ''' ''' | ''' ''' | '''&#x2713;''' | '''&#x2713;'''
 }}{{TableRowN| site_user              | access_level         | String    | The current access level for website or API access.     | ''' ''' | ''' ''' | '''&#x2713;''' | '''&#x2713;'''
 }}{{TableRowN| site_user              | address         | Object    | (See [[Sensaphone.net API/address|Sensaphone.net API/address]])     | ''' ''' | ''' ''' | '''&#x2713;''' | '''&#x2713;'''
-}}{{TableRowN| user                     | is_alarm_user         | Boolean    | If the user is enabled for alarm delivery.     | '''&#x2713;''' | ''' ''' | '''&#x2713;''' | '' '''
+}}{{TableRowN| user                     | is_alarm_user         | Boolean    | If the user is enabled for alarm delivery.     | ''' ''' | ''' ''' | '''&#x2713;''' | ''' '''
 }}{{TableRowN| user                     | alarm_user         | Object    | sub-object contains data for where is_alarm_user is 'true'. Is still accessed using the "user" resource.     | ''' ''' | ''' ''' | '''&#x2713;''' | '''&#x2713;'''
-}}{{TableRowN| alarm_user              | schedule         | Object    | (See [[Sensaphone.net API/schedule|Sensaphone.net API/schedule]])     | '''&#x2713;''' | ''' ''' | '''&#x2713;''' | '''&#x2713;'''
+}}{{TableRowN| alarm_user              | schedule         | Object    | (See [[Sensaphone.net API/schedule|Sensaphone.net API/schedule]])     | ''' ''' | ''' ''' | '''&#x2713;''' | '''&#x2713;'''
-}}{{TableRowN| alarm_user              | contact        | Array of Object    | (See [[Sensaphone.net API/contact|Sensaphone.net API/contact]])     | '''&#x2713;''' | ''' ''' | '''&#x2713;''' | '''&#x2713;'''
+}}{{TableRowN| alarm_user              | contact        | Array of Object    | (See [[Sensaphone.net API/contact|Sensaphone.net API/contact]])     | ''' ''' | ''' ''' | '''&#x2713;''' | '''&#x2713;'''
 }}{{TableEnd}}

@@ Line 42: / Line 42: @@
 }}{{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 "user" resource, if any. See the [[Sensaphone.net_API#List|'''list''']].
@@ Line 154: / Line 154: @@
 }}{{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 "user" resource, if any. See the [[Sensaphone.net_API#List|'''list''']].
@@ Line 200: / Line 200: @@
 }}{{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 "user" resource, if any. See the [[Sensaphone.net_API#List|'''list''']].
@@ Line 244: / Line 244: @@
 }}{{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 "user" resource, if any. See the [[Sensaphone.net_API#List|'''list''']].

@@ Line 72: / Line 72: @@
 ====Example JSON====
-Receive all Contact information
+Receive all User information
 * '''Request JSON:'''

@@ Line 188: / Line 188: @@
 ===POST===
-The preferred method to create a new Contact is to use the JSON Mode Request. If the URI Mode Request is used you will be adding a Contact with only the '''contact_name''' value, all other values will be left empty until a PUT request is used. With the JSON Mode Request you can create a Contact with all values defined in one step.
+The preferred method to create a new User is to use the JSON Mode Request. If the URI Mode Request is used you will be adding a User with only the '''name''' value, all other values will be left empty until a PUT request is used. With the JSON Mode Request you can create a User with all values defined in one step.
 '''URI Mode Request URI:'''
-*Create a new Contact
+*Create a new User
     '''POST''' <nowiki>https://</nowiki>rest.sensaphone.net/api/v1/{ACCTID}/{SESSIONID}/user/name/{NAME}
 '''JSON Mode Request URI'''

@@ Line 57: / Line 57: @@
 }}{{TableRowN| user            | enable                  | Optional     | Boolean          | If the user is enabled.
 }}{{TableRowN| user            | alarm_user_mode   | Optional     | String          | The alarm user mode.
 }}{{TableRowN| user            | is_site_user            | Optional     | Boolean          | If the user has site access (website or API)
 }}{{TableRowN| user            | site_user               | Optional     | Object           | sub-object contains data for where is_site_user is 'true'. Is still accessed using the "user" resource.
@@ Line 171: / Line 172: @@
 }}{{TableRowN| user            | enable                  | Optional     | Boolean          | If the user is enabled.
 }}{{TableRowN| user            | alarm_user_mode   | Optional     | String          | The alarm user mode.
 }}{{TableRowN| user            | is_site_user            | Optional     | Boolean          | If the user has site access (website or API)
 }}{{TableRowN| user            | site_user               | Optional     | Object           | sub-object contains data for where is_site_user is 'true'. Is still accessed using the "user" resource.