role.fetch

Description

Fetch a single role object.  Please see Fetching Objects for an overview of how the fetch method works.

Parameters

role id

An integer representing the unique id of the role to fetch.  You may also pass a json object with a field of id to identify the role you wish to fetch.

Response

An role object, as described by the object.describe call. NULL is returned if the member could not be found.

Examples

A Sample JSON-RPC Role Fetch Request

{
    "method": "role.fetch",
    "params": [378],
    "id": 1
}

The JSON-RPC Response

{
    "result": {
        "id": 378,
        "created": "2009-12-02T23:46:49Z",
        "updated": "2009-12-02T23:46:49Z",
        "name": "example_role_name",
        "description": "",
        "is_assignable": true,
        "is_predefined": false,
        "object_type": "role"
    },
    "error": null,
    "id": 1
}

Permissions Required

The user who owns the key used to authenticate the role.fetch call must be a member of one of the following roles

• Administrator
• Program Manager
• Community Manager
• Content Manager
• Portal Manager
• Api Manager

See authentication.

Errors

In addition to the standard json-rpc errors and authentication errors, role.fetch may also return these errors: