Platform.converdge.com

Content: API; UPML; UPML Console

Up.groups.get

Returns all visible groups according to the filters specified. This may be used to find all groups of which a user is as member, or to query specific gids.

Parameters

Type	Name	Required	Description
`string`	api_key	✔	The application key associated with the calling application.
`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`	uid		Filter by groups associated with a user with this uid
`array`	gids		Filter by this list of group ids. This is a comma-separated list of gids.

This method returns all groups satisfying the filters specified. The method can be used to return all groups associated with user, or query a specific set of groups by a list of gids.

If both the uid and gids parameters are provided, the method returns all groups in the set of gids with which the user is associated. If the gids parameter is omitted, the method returns all groups associated with the provided user.

If, instead, the uid parameter is omitted, the method returns all groups associated with the provided gids, regardless of any user relationship.

If both parameters are omitted, the method returns all groups of the session user.

Example return XML

<?xml version="1.0" encoding="UTF-8"?>
<groups_get_response list="true">
    <group>
      <gid>2206609142</gid>
      <name>Donald Knuth Is My Homeboy</name>
      <nid>0</nid>
      <description>Donald Ervin Knuth (born January 10, 1938) is a renowned computer scientist and professor emeritus at Stanford University.
Knuth is best known as the author of the multi-volume The Art of Computer Programming, one of the most highly respected references in the 
computer science field. He practically created the field of rigorous analysis of algorithms, and made many seminal contributions to several branches of
theoretical computer science. He is also the creator of the TeX typesetting system and of the METAFONT font design system, and pioneered the concept of 
literate programming.
 
      That's how he ROLLS, y0.</description>
      <group_type>Just for Fun</group_type>
      <group_subtype>Fan Clubs</group_subtype>
      <recent_news/>
      <pic>http://photos-142.universalplatform.com/ip006/object/543/95/s2206609142_32530.jpg</pic>
      <pic_big>http://photos-142.universalplatform.com/ip006/object/543/95/n2206609142_32530.jpg</pic>
      <pic_small>http://photos-142.universalplatform.com/ip006/object/543/95/t2206609142_32530.jpg</pic>
      <creator>1240077</creator>
      <update_time>1156543965</update_time>
      <office/>
      <website/>
      <venue>
        <street/>
        <city/>
        <state>CA</state>
        <country>United States</country>
      </venue>
    </group>
</groups_get_response>

Response

Groups are only visible if they are not secret. If no such groups are found, the method will return an empty groups_get_response element. The nid field will be 0 for global groups.

Note the following size constraints on photos returned:

pic - URL of group photo, with max width 100px and max height 300px. May be blank.
pic_big - URL of group photo, with max width 200px and max height 600px. May be blank.
pic_small - URL of group photo, with with max width 50px and max height 150px. May be blank.

Privacy note: Group creators will be visible to an application only if the creator has not turned off access to the Platform or used the application; if the creator has opted out, the creator element will appear in the following format:

<creator xsi:nil="true"/>

UPQL equivalent

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

SELECT gid, name, nid, description, group_type, group_subtype, recent_news,
       pic, pic_big, pic_small, creator, update_time, office, website, venue
FROM GROUP
WHERE gid IN (SELECT gid FROM group_member WHERE uid=uid) AND
      gid IN (gids)

Error codes