Small World Labs

Description

Returns a list of groups on the site. This method does NOT return the members of the group. Please see groups.getMembers.

---

Authentication

This method requires authentication without user credentials.

---

API Version

Version 1&2

---

Required parameters

• None

---

Optional parameters

• group_id :
  the id number of the group
• name :
  the name of the group
• description :
  a brief description of the group
• created :
  the date on which the group was created formatted according to RFC 822 standards
• group_owner_id :
  the id number of the user who owns the group. The list of user ids is available from the users.getList call.
• access :
  the access level of the group. This has four possible values:
  • 0 : Public - all users can view and create content in the group
  • 1 : Open - all users can view group content, members can create content
  • 2 : Closed - only members can view and create group content
  • 3 : Hidden - only members can see that the group exists
• news :
  this is a place for the group administrators and moderators to post updates about the group
• welcome_message :
  this is a message shown on the groups main page to welcome guests and members
• state :
  the state associated with this group
• country :
  the contry associated with this group
• permalink :
  the permalink used to access the group. This can be appended to the site url (ex. http://SITENAME/PERMALINK).
• ss_key : the key of the community associated with the group. The list of communities is available from the communities.getList call.
• interest_key : the key of a site interest associated with the group. The list of interests is available from the siteinterests.getList call.
• subinterest_key : the key of a site sub-interest associated with the group. The list of interests is available from the siteinterests.getList call.

---

Example response

<?xml version="1.0"?>
<response status="ok" time="Tue, 22 Apr 2008 09:19:00 -0500">
    <groups count="2" total="5">
        <group>
            <group_id>1</group_id>
            <name>

                <![CDATA[Group Name]]>
            </name>
            <description>
                <![CDATA[Description]]>
            </description>
            <created>

                <![CDATA[Mon, 29 Oct 2007 17:16:28 -0500]]>
            </created>
            <group_owner_id>14</group_owner_id>
            <access label="Public">0</access>
            <news>

                <![CDATA[News]]>
            </news>
            <welcome_message>
                <![CDATA[Welcome Message]]>
            </welcome_message>
            <city/>

            <state/>
            <country/>
            <permalink/>
        </group>
        <group>

            <group_id>2</group_id>
            <name>
                <![CDATA[xbox 360 playas]]>
            </name>
            <description>

                <![CDATA[get your game on]]>
            </description>
            <created>
                <![CDATA[Fri, 02 Nov 2007 10:36:08 -0500]]>
            </created>
            <group_owner_id>1</group_owner_id>

            <access label="Public">0</access>
            <news>
                <![CDATA[Signup and checkout the new group!]]>
            </news>
            <welcome_message>

                <![CDATA[Welcome to the xbox 360 playas group]]>
            </welcome_message>
            <city/>
            <state/>
            <country/>
            <permalink/>
        </group>

    </groups>
</response>