Page last modified 00:11, 19 Mar 2009 by MaxM
Table of contents
- 1. Overview
- 1.1.1.1. Uri Parameters
- 1.1.1.2. Query Parameters
- 1.1.1.3. Return Codes
- 2. Message Format
- 3. Implementation Notes
- 4. Code Samples
Overview
public. Retrieve a role
Uri Parameters
| Name | Type | Description |
| roleid | string | either an integer role ID or "=" followed by a double uri-encoded role name |
Query Parameters
| Name | Type | Description |
| authenticate | bool? | Force authentication for request (default: false) |
Return Codes
| Name | Value | Description |
| BadRequest | 400 | Invalid input parameter or request body |
| NotFound | 404 | Requested role could not be found |
| Ok | 200 | The request completed successfully |
Message Format
Output:
<permissions>
<operations mask="{int}">{text}</operations>
<role id="{int}" href="{uri}">{text}</role>
</permissions>
Implementation Notes
Use GET:site/operations to retrieve a list of all operations currently defined on the site.
Code Samples
The following code example retrieves information about the Admin role:
Plug p = Plug.New("http://deki-hayes/@api/deki");
p.At("users", "authenticate").WithCredentials("admin", "password").Get();
p.At("site", "roles", "=Admin").Get();
Sample response:
<permissions>
<operations mask="9223372036854779903">LOGIN,BROWSE,READ,SUBSCRIBE,UPDATE,CREATE,DELETE,CHANGEPERMISSIONS,CONTROLPANEL,ADMIN</operations>
<role id="5" href="http://deki-hayes/@api/deki/site/roles/5">Admin</role>
</permissions>
- Tag page
- What links here
Images 0
You must login to post a comment.