Groups

Create a group

You can use POST method to create a group.
Request:

POST   /api/groups?groupname=Marketing&restrictiontype=A&restrictiongroups=Administration&blockfile=0
restrictiontype:

A : Allow D : Deny {} : No Restriction

 

restrictiongroups:

Group to be restricted for the users in the group.

 
blockfile :

1 – Block file transfer. 0 – Allow file transfer.

restrictiontype, restrictiongroup, blockfile are optional.
Response:

Status: 200 OK { "success":true }

 

Update a group

To update a group, you can use PUT method.
Request:

PUT     /api/groups/[group]?groupname=Marketers&restrictiontype=A&restrictiongroups=Administration&blockfile=0
[group] – Previous group name.

groupname, restrictiongroups, restrictiontype, blockfile are optional.
Response:

Status: 200 OK { "success":true }

 

Deleting a group

To Delete a group, you can use DELETE method.
Request:

DELETE    /api/groups/[group]
[group] – Groupname.

Response:

Status: 200 OK  {  "success":true  }

 

Retrieving a group

For retrieving a group, you can use GET method.
Request:

GET      /api/groups/[group]
[group] – Groupname.

Response:

Status: 200 OK  {  "row":{  "groupname":"Marketer",  "restrictiontype":"A",  "restrictiongroups":"Administration",  "blockfile":0  },  "success":true  }

 

Retrieving all groups

For retrieving all the groups, you can use GET method.
Request:

GET    /api/groups

Response:

Status: 200 OK { "row":{ "groupname":"Marketers", "restrictiontype":"A", "restrictiongroups":"Administration", "blockfile":0 }, { "groupname":"Administration", "restrictiontype":"", "restrictiongroups":"", "blockfile":0 }, "success":true }