API Mobile Briefcase Users List

From unroole CMS wiki
Revision as of 09:52, 29 November 2013 by Mbasset (Talk | contribs)

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/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 500 The maximum number of mobile briefcase users to return.
page 1 Depends on query Integer The current pages to display based on the limit.

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:
Field Type
id integer
username string
domain string
page integer The current viewed page of results.
per-page integer The maximum number of results to return per page.
total-pages integer The total number of pages that exist.
total-entries integer The total number of entries found from all pages.
result_length integer Total number of results that have been returned on this page. This may differ from the per-page/limit value on the last page.

Examples

All mobile briefcase users on an account

Parameters Values
token 1f0qpLwoV5oIcfnU2yvO

Search for domain 'santa'

Parameters Values
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