API Mobile Briefcase Users List

From unroole CMS wiki
Revision as of 13:48, 31 May 2012 by Tommy.leung (Talk | contribs)

(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to: navigation, search

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/[account-id]/mobile_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 User:
Field Type
username string
domain string
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.
Retrieved from "https://wiki.unroole.com/index.php?title=API_Mobile_Briefcase_Users_List&oldid=1137"