Difference between revisions of "API Accounts List"
From unroole CMS wiki
Tommy.leung (Talk | contribs) (Created page with "== Summary == Allows querying for a list of accounts belonging to the user. == URI == {{:API_Base_URI}}accounts == HTTP Method == GET == Required Paramaters == {| class="w...") |
Tommy.leung (Talk | contribs) (→Response) |
||
| Line 32: | Line 32: | ||
| array of [[API Account Fields]] | | array of [[API Account Fields]] | ||
| List of accounts | | 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. | ||
|} | |} | ||
Revision as of 13:09, 31 May 2012
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. |
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. |
