Usergroups¶

Usergroups are as the name suggests a group of users formed using the id’s with which they are registered in BuildingDepot. Usergroups when combined with SensorGroups help in bringing about the Access Control functions that BuildingDepot provides.UserGroups can be defined in the CentralService at http://www.example.com:81/api/usergroup.

Create UserGroup¶

This request creates a new UserGroup with the name and description as specified by the user.

POST /api/user_group¶

JSON Parameters:

data (dictionary) – Contains the information about the UserGroup
- name (string) – Name of the UserGroup
- description (string) – Description of the UserGroup

Returns:

success (string) – Returns ‘True’ if data is posted successfully otherwise ‘False’
error (string) – An additional value that will be present only if the request fails specifying the cause for failure

Status Codes:

200 OK – Success
401 Unauthorized – Unauthorized Credentials

Example request:

POST /api/user_group HTTP/1.1
Accept: application/json; charset=utf-8

{
  "data": {
          "name": "Test User Group",
          "description": "Description for User Group"
      }
}

Example response (for success):

HTTP/1.1 200 OK
Content-Type: application/json

{
  "success": "True"
}

Example response (for failure):

HTTP/1.1 200 OK
Content-Type: application/json

{
  "success": "False",
  "error": "No Name"
}

Get UserGroup Details¶

This request retrieves the details of a UserGroup

GET /api/user_group/<name>¶

Parameters:

name (string) – Name of user group (compulsory)

Returns:

name (string) – Contains the name of the UserGroup
description (string) – Contains the description of the UserGroup

Status Codes:

200 OK – Success
401 Unauthorized – Unauthorized Credentials

Example request:

GET /api/user_group/Test HTTP/1.1
Accept: application/json; charset=utf-8

Example response (for success):

HTTP/1.1 200 OK
Content-Type: application/json

{
  "success" : "true",
  "name":"Test",
  "description":"A UserGroup for Test"
}

Example response (for failure):

HTTP/1.1 200 OK
Content-Type: application/json

{
  "success": "False",
  "error": "Usergroup does not exist"
}

Delete UserGroup¶

This request deletes the UserGroup

DELETE /api/user_group/Test¶

Parameters:

email (string) – Name of the UserGroup

Returns:

success (string) – Returns ‘True’ if the UserGroup is successfully deleted otherwise ‘False’

Status Codes:

200 OK – Success
401 Unauthorized – Unauthorized Credentials

Example request:

DELETE /api/user_group/<name> HTTP/1.1
Accept: application/json; charset=utf-8

Example response (for success):

HTTP/1.1 200 OK
Content-Type: application/json

{
  "success": "True"
}

Example response (for failure):

HTTP/1.1 200 OK
Content-Type: application/json

{
  "success": "False",
  "error": "Usergroup does not exist"
}

Add users to UserGroup¶

This request adds the users specified in the request to the usergroup

Note: The list of users sent in this request will overwrite the previous list

POST /api/user_group/<name>/users¶

Parameters:

name (string) – Name of UserGroup

JSON Parameters:

data (dictionary) – Contains the information of the users to be added to the UserGroup.
- users (list) – List of user objects
  
  user_id (string) – Email of the user
  
  manager (boolean) – Specifies whether the user is a manager of the UserGroup

Returns:

success (string) – Returns ‘True’ if data is posted successfully otherwise ‘False’
error (string) – An additional value that will be present only if the request fails specifying the cause for failure

Status Codes:

200 OK – Success
401 Unauthorized – Unauthorized Credentials

Example request:

POST /api/user_group/Test/users HTTP/1.1
Accept: application/json; charset=utf-8

{
  "data":{
      "users":[
           {
              "user_id":"synergy@gmail.com",
              "manager": true
           },
           {
              "user_id":"test@gmail.com",
              "manager": false
           }
         ]
  }
}

Example response (for success):

HTTP/1.1 200 OK
Content-Type: application/json

{
  "success": "True"
}

Example response (for failure):

HTTP/1.1 200 OK
Content-Type: application/json

{
  "success": "False",
  "error": "One or more users not registered"
}

Get list of users in UserGroup¶

This request retrieves the list of users that are in the specified UserGroup

GET /api/user_group/<name>/users¶

Parameters:

name (string) – Name of user group (compulsory)

Returns:

users (list) – Contains the list of users in this UserGroup

Status Codes:

200 OK – Success
401 Unauthorized – Unauthorized Credentials

Example request:

GET /api/user_group/Test/users HTTP/1.1
Accept: application/json; charset=utf-8

Example response:

HTTP/1.1 200 OK
Content-Type: application/json

{
  "users": [
             {
                "user_id":"synergy@gmail.com",
                "manager": true
             },
             {
                "user_id":"test@gmail.com",
                "manager": false
             }
           ]
}