API Collections Manage Users

Summary

Allows for managing users in a collection.

URI

https://api.unroole.com/collections/[collection-id]/update_users

HTTP Method

POST

Required Paramaters

Paramater	Default	Maximum Length	Accepted Values	Description
token				API Persistence Token that identifies this user and its permissions.

Optional Paramaters

Paramater	Default	Maximum Length	Accepted Values	Description
ids[]			Array of integers	Array of mobile briefcase users ids to add.
filter_ids[]	All users belonging to that account.		Array of integers	Array of mobile briefcase users ids to act upon. This list should be a subset of the mobile briefcase users on the account, so that only SOME of the mobile briefcase users on the account will be affected. If there are extra ids in this list, which are NOT in the ids[] list, then those will be deleted from this collection.

Response

Field	Type	Description
http_status	integer	API Status Code http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html
error		Rails default
added_users	array of ids	List of users that were successfully added to the collection.
deleted_users	array of ids	List of users that were successfully deleted from the collection.
rejected_users	array of ids	List of users that failed to be added or delete. Mostly likely the user does not belong to this account.

Examples

Add new users

Add Users: 1, 2, 24, 64, 89, 12

Request:

Paramater	Value
ids[]	[1,2,24,64,89,12]

Response:

Delete users

Delete Users: 3, 45, 85

Request:

Paramater	Value
filter_ids[]	[3,45,85]

Response:

Delete all users

Delete all users from the collection.

Request:

No parameters need to be sent.

Response:

Add and remove users

Add Users: 1, 10, 12

Delete Users: 2, 6, 8

Request:

Paramater	Value
ids[]	[1,10,12]
filter_ids[]	[1,2,6,8,10,12]

Response: