member.fetch

Description

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

Parameters

username

A string representing the unique id of the member to fetch.  You may also pass a json object with a field of id to identify the member you wish to fetch.

Response

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

Examples

A Sample JSON-RPC Member Fetch Request

{
    "method": "member.fetch",
    "params": ["example_username"],
    "id": 1
}

The JSON-RPC Response

{
    "result": {
        "created": "2009-12-12T01:05:55Z",
        "updated": "2009-12-12T01:05:55Z",
        "username": "example_username",
        "email": "joe@example.com",
        "display_name": "Joe P. User",
        "uri": "",
        "blog": "",
        "im": "",
        "imsvc": "",
        "phone": "",
        "company": "",
        "address1": "",
        "address2": "",
        "locality": "",
        "region": "",
        "postal_code": "",
        "country_code": "",
        "first_name": "",
        "last_name": "",
        "registration_ipaddr": "",
        "area_status": "waiting",
        "external_id": "",
        "passwd_new": "",
        "object_type": "member"
    },
    "error": null,
    "id": 1
}

Permissions Required

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

• Administrator
• Program Manager
• Community Manager

See authentication.

Errors

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