API Collections Manage Users
From unroole CMS wiki
Revision as of 09:10, 1 June 2012 by Tommy.leung (Talk | contribs)
Contents
Summary
Allows for managing users in a collection.
URI
https://api.unroole.com/[channel-id]/sorted_playlists/[playlist-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 |
|---|---|---|---|---|
| bulk_change_mobile_users_ids[] | Array of integers | Array of mobile briefcase users ids to add/delete | ||
| bulk_change_mobile_users_filter_ids[] | All users belonging to that account. | Array of integers | Array of mobile briefcase users ids to act upon. |
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. |
| failed_users | array of items | List of users that failed to be added or delete. |
Notes
- To add users, set bulk_change_mobile_users_ids[] and bulk_change_mobile_users_filter_ids[] to be the same.
- To delete users, set set bulk_change_mobile_users_ids[] to blank, and bulk_change_mobile_users_filter_ids[] to the list of users to be deleted.
