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. There are several possibilities for a rejected user: * the user does not belong to this account. * the user was not part of the filter_ids list. * the user was not in the original list so it could not be deleted.
|
Examples
these example require jQuery
Add new users 1, 2, 3
Paramater
|
Value
|
token
|
1f0qpLwoV5oIcfnU2yvO
|
ids[]
|
[1,2,3]
|
jQuery ajax call
|
$.ajax('http://api.unroole.com/collections/2/update_users?token=1f0qpLwoV5oIcfnU2yvO', {
headers: {
// use below for json request
Accept : "application/json, text/javascript"
// use below for xml request
//Accept : "text/html,application/xhtml+xml,application/xml"
},
type: 'POST',
data: {
ids: [1,2,3],
filter_ids: []
}
});
|
JSON
|
{"added_users":[1,2,3],"deleted_users":[],"rejected_users":[],"http_status":200}
|
XML
|
<?xml version="1.0" encoding="UTF-8"?>
<hash>
<added-users type="array">
<added-user type="integer">1</added-user>
<added-user type="integer">2</added-user>
<added-user type="integer">3</added-user>
</added-users>
<deleted-users type="array"/>
<rejected-users type="array"/>
<http-status type="integer">200</http-status>
</hash>
|
Delete users 2, 3
Paramater
|
Value
|
token
|
1f0qpLwoV5oIcfnU2yvO
|
filter_ids[]
|
[2,3]
|
jQuery ajax call
|
$.ajax('http://api.unroole.com/collections/2/update_users?token=1f0qpLwoV5oIcfnU2yvO', {
headers: {
// use below for json request
Accept : "application/json, text/javascript"
// use below for xml request
//Accept : "text/html,application/xhtml+xml,application/xml"
},
type: 'POST',
data: {
ids: [],
filter_ids: [2,3]
}
});
|
JSON
|
{"added_users":[],"deleted_users":[2,3],"rejected_users":[],"http_status":200}
|
XML
|
<?xml version="1.0" encoding="UTF-8"?>
<hash>
<added-users type="array"/>
<deleted-users type="array">
<deleted-user type="integer">2</deleted-user>
<deleted-user type="integer">3</deleted-user>
</deleted-users>
<rejected-users type="array"/>
<http-status type="integer">200</http-status>
</hash>
|
Delete all users
Paramater
|
Value
|
token
|
1f0qpLwoV5oIcfnU2yvO
|
jQuery ajax call
|
$.ajax('http://api.unroole.com/collections/2/update_users?token=1f0qpLwoV5oIcfnU2yvO', {
headers: {
// use below for json request
//Accept : "application/json, text/javascript"
// use below for xml request
Accept : "text/html,application/xhtml+xml,application/xml"
},
type: 'POST',
data: {
ids: [],
filter_ids: []
}
});
|
JSON
|
{"added_users":[],"deleted_users":[1,2,3,4,5],"rejected_users":[],"http_status":200}
|
XML
|
<?xml version="1.0" encoding="UTF-8"?>
<hash>
<added-users type="array"/>
<deleted-users type="array">
<deleted-user type="integer">1</deleted-user>
<deleted-user type="integer">2</deleted-user>
<deleted-user type="integer">3</deleted-user>
<deleted-user type="integer">4</deleted-user>
<deleted-user type="integer">5</deleted-user>
</deleted-users>
<rejected-users type="array"/>
<http-status type="integer">200</http-status>
</hash>
|
Add and delete users
Paramater
|
Value
|
token
|
1f0qpLwoV5oIcfnU2yvO
|
ids[]
|
[3,4]
|
filter_ids[]
|
[1,2,3,4]
|
jQuery ajax call
|
$.ajax('http://api.unroole.com/collections/2/update_users?token=1f0qpLwoV5oIcfnU2yvO', {
headers: {
// use below for json request
Accept : "application/json, text/javascript"
// use below for xml request
//Accept : "text/html,application/xhtml+xml,application/xml"
},
type: 'POST',
data: {
ids: [3,4],
filter_ids: [1,2,3,4]
}
});
|
JSON
|
{"added_users":[3,4],"deleted_users":[1,2],"rejected_users":[],"http_status":200}
|
XML
|
<?xml version="1.0" encoding="UTF-8"?>
<hash>
<added-users type="array">
<added-user type="integer">3</added-user>
<added-user type="integer">4</added-user>
</added-users>
<deleted-users type="array">
<deleted-user type="integer">1</deleted-user>
<deleted-user type="integer">2</deleted-user>
</deleted-users>
<rejected-users type="array"/>
<http-status type="integer">200</http-status>
</hash>
|