Latest revision as of 07:38, 1 May 2015

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:

GET

URI Request Mode URI's:

• Retrieve all user data for all users in the account.

   GET https://rest.sensaphone.net/api/v1/{ACCTID}/{SESSIONID}/user

• Retrieve all user data for a specific user.

    GET https://rest.sensaphone.net/api/v1/{ACCTID}/{SESSIONID}/user/{USER_ID}

• Retrieve the name of a specific user.

    GET https://rest.sensaphone.net/api/v1/{ACCTID}/{SESSIONID}/user/{USER_ID}/name

JSON Request Mode URI:

    POST https://rest.sensaphone.net/api/v1/user

JSON Mode Request Properties

JSON Mode Response Properties

Example JSON

Receive all User 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": "[email protected]",
        "access_level": "Admin",
        "address":{
          ...                       ← See here for address object specification       
        }
      },
      "is_alarm_user": true,
      "alarm_user": {
        "schedule":{
          ...                       ← See here for schedule object specification
        },
        "contact":[
          {
            "contact_id": 1201,
            ...                     ← See 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 https://rest.sensaphone.net/api/v1/{ACCTID}/{SESSIONID}/user/{USER_ID}/name/{NAME}

JSON Mode Request URI:

   POST https://rest.sensaphone.net/api/v1/user

JSON Mode Request Properties

*One or more user child properties listed below are required in addition to "user_id".

JSON Mode Response Properties

POST

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 User

  POST https://rest.sensaphone.net/api/v1/{ACCTID}/{SESSIONID}/user/name/{NAME}

JSON Mode Request URI

  POST https://rest.sensaphone.net/api/v1/user

JSON Mode Request Properties

*One or more user child properties listed below may be specified in addition to "user_id" and "name".

JSON Mode Response Properties

DELETE

URI Mode Request URI's:

• Delete a User

  DELETE https://rest.sensaphone.net/api/v1/{ACCTID}/{SESSIONID}/user/{USER_ID}

JSON Mode Request URI:

  POST https://rest.sensaphone.net/api/v1/user

JSON Mode Request Properties