Difference between revisions of "API Mobile Briefcase Users List"
From unroole CMS wiki
Tommy.leung (Talk | contribs) (→URI) |
Tommy.leung (Talk | contribs) (→Response) |
||
Line 61: | Line 61: | ||
! Field | ! Field | ||
! Type | ! Type | ||
+ | |- | ||
+ | | id | ||
+ | | integer | ||
|- | |- | ||
| username | | username |
Revision as of 12:45, 25 June 2012
Summary
Allows querying for a list of assets. The query is a wildcard search on the asset's:
- username
- domain
URI
https://api.unroole.com/accounts/[account-id]/mobile_briefcase_users
HTTP Method
GET
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 |
---|---|---|---|---|
search | string | The search terms to be used in the query. | ||
limit | TBD | The maximum number of mobile briefcase users to return. |
Response
Field | Type | Description | ||||||||
---|---|---|---|---|---|---|---|---|---|---|
http_status | integer | API Status Code http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html | ||||||||
error | Rails default | |||||||||
users | array of users | Each user:
| ||||||||
result_length | integer | Total number of results that could be returned. This may not be the number of mobile briefcase users in the response, as it is truncated by limit parameter. |