MediaPost Social Network

Up.groups.getMembers

Returns membership list data associated with a group.

Parameters

Type Name Required Description
string api_key The application key associated with the calling application.
string community Community system name. Use up.community.getList method to retrieve available communities.
string session_key The session key of the logged in user.
string sig An MD5 hash of the current request and your secret key, as described in the authentication guide.
string format Desired response format. Either XML (default) or JSON.
int gid Group id for which to retrieve member list

Example return XML

<?xml version="1.0" encoding="UTF-8"?>
<groups_getMembers_response list="true">
    <members list="true">
      <uid>1240077</uid>
      <uid>1240078</uid>
      <uid>222332</uid>
      <uid>222333</uid>
    </members>
    <admins list="true">
      <uid>1240077</uid>
      <uid>222333</uid>
    </admins>
    <creator list="true">
      <uid>56454545</uid>
    </creator>
    <not_approved list="true"/>
</groups_getMembers_response>

Response

This method returns four (possibly empty) lists of users associated with a group, keyed on their associations (membership status). The members list will contain the officers and admins lists, but will not overlap with the not_replied list.

Privacy note: The lists can contain uids of users not using the calling application.

UPQL Equivalent

This function is similar to doing the following UPQL query, with the appropriate parameters filled in:

SELECT uid, gid, positions FROM group_member WHERE gid=gid

Error codes

Code Description
1 An unknown error occurred. Please resubmit the request.
2 The service is not available at this time.
4 The application has reached the maximum number of requests allowed. More requests are allowed once the time window has completed.
5 The request came from a remote address not allowed by this application.
100 One of the parameters specified was missing or invalid.
101 The api key submitted is not associated with any known application.
102 The session key was improperly submitted or has reached its timeout. Direct the user to log in again to obtain another key.
103 The submitted call_id was not greater than the previous call_id for this session.
104 Incorrect signature.