Facebook Methods description: groups.get

anna_150.jpg

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

 

string api_key The application key associated with the calling application.
string session_key The session key of the logged in user.
float call_id The request’s sequence number. Each successive call for any session must use a sequence number greater than the last. We suggest using the current time in milliseconds, such as PHP’s microtime(true) function.
string sig An MD5 hash of the current request and your secret key, as described in the authentication guide.
string v This must be set to 1.0 to use this version of the API.
string format Optional - desired response format. Either “XML” (default) or “JSON”.
string callback Optional - wrap the response inside a function call. This is primarily to enable cross-domain javascript requests using the <script> tag, sometimes known as “JSONP“. This works with both XML and JSON.
int uid Optional - Filter by groups associated with a user with this uid
array gids Optional - 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 events 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 associted 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 xmlns="http://api.facebook.com/1.0/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://api.facebook.com/1.0/ http://api.facebook.com/1.0/facebook.xsd" 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.facebook.com/ip006/object/543/95/s2206609142_32530.jpg</pic>
    <pic_big>http://photos-142.facebook.com/ip006/object/543/95/n2206609142_32530.jpg</pic>
    <pic_small>http://photos-142.facebook.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>
      <latitude>37.775</latitude>
      <longitude>-122.418</longitude>
    </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"/>

FQL Equivalent

This function is similar to doing the following FQL 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

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.

Source page

Tags: ,

Related Post

February 26th, 2008
Categories: Apps development, Facebook Methods . Author: admin

No Comments

No comments yet.

Comments RSS TrackBack Identifier URI

Leave a comment

Facebook News: Victim of Their Success ? Facebook Methods description: fql.query