API Method /users/groups/list
Lists all groups of which the user is a member.
Arguments
- authentication
- This method requires the usual authentication
arguments.
- id string
- The user ID.
Example Request
Here's an example request URL:
http://api.evdb.com/rest/users/groups/list?...&id=paulymer5
Output Parameters
Output from this function is an XML block of groups with the following elements:
- groups
- An array of groups with the following elements in each group:
- id string
- The group ID.
- group_name string
- The group name.
- group_desc string
- The group description.
- creator string
- The username who created this group
- member_count integer
- The number of members of the group.
-
Example XML Response
<?xml version="1.0" encoding="UTF-8"?>
<groups>
<group id="G0-001-000000120-2">
<group_name>Cool group.</group_name>
<group_desc>This is a group description.</group_desc>
<creator>paulymer5</creator>
<member_count>9</member_count>
</group>
...
</groups>
Error Codes
This method may return these errors in an error document:
- Authentication error
- The specified user was not found or provided invalid credentials.
- Missing parameter
- A mandatory field was not provided.
- Not found
- The specified user id was not found.
-