Difference between revisions of "API Mobile Briefcase Users List"
Tommy.leung (Talk | contribs) (→Examples) |
Tommy.leung (Talk | contribs) (→Search for the first elf) |
||
Line 248: | Line 248: | ||
=== Search for the first elf === | === Search for the first elf === | ||
+ | ''result_length is 2 because there are 2 mobile briefcase users that can be returned, but the user requested only for 1'' | ||
{| class="wikitable" | {| class="wikitable" |
Revision as of 10:33, 26 June 2012
Contents
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. |
Examples
All mobile briefcase users on an account
Parameters | Values |
---|---|
token | 1f0qpLwoV5oIcfnU2yvO |
JSON |
---|
http://api.unroole.com/accounts/1/mobile_briefcase_users.xml?token=1f0qpLwoV5oIcfnU2yvO |
|
XML |
---|
http://api.unroole.com/accounts/1/mobile_briefcase_users.xml?token=1f0qpLwoV5oIcfnU2yvO |
|
Search for domain 'santa'
Parameters | Values |
---|---|
token | 1f0qpLwoV5oIcfnU2yvO |
search | santa |
JSON |
---|
http://api.unroole.com/accounts/1/mobile_briefcase_users.json?token=1f0qpLwoV5oIcfnU2yvO&search=santa |
|
XML |
---|
http://api.unroole.com/accounts/1/mobile_briefcase_users.xml?token=1f0qpLwoV5oIcfnU2yvO&search=santa |
|
Search for the first elf
result_length is 2 because there are 2 mobile briefcase users that can be returned, but the user requested only for 1
Parameters | Values |
---|---|
token | 1f0qpLwoV5oIcfnU2yvO |
search | elf |
JSON |
---|
http://api.unroole.com/accounts/1/mobile_briefcase_users.json?token=1f0qpLwoV5oIcfnU2yvO&search=elf&limit=1 |
|
XML |
---|
http://api.unroole.com/accounts/1/mobile_briefcase_users.xml?token=1f0qpLwoV5oIcfnU2yvO&search=elf&limit=1 |
|