API Accounts List
From unroole CMS wiki
Revision as of 13:12, 31 May 2012 by Tommy.leung (Talk | contribs)
Summary
Allows querying for a list of accounts belonging to the user.
URI
https://api.unroole.com/accounts
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 accounts to return. | ||
| fields | id, name, url, logo_url | API Asset Fields | List of comma separated fields to be returned in the response. | |
| url_time_limit | 60 | The length of time (in seconds) that the logo url will be accessible for. This only applies to the response. |
Response
| Field | Type | Description |
|---|---|---|
| http_status | integer | API Status Code http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html |
| error | Rails default | |
| accounts | array of API Account Fields | List of accounts |
| result_length | integer | Total number of results that could be returned. This may not be the number of accounts in the response, as it is truncated by limit parameter. |
