list visible groups

Description

Returns the list of groups visible to the specified member.

A visible group is one that the member does not belong to and has the Group Setting Group Visible to: equal to "public" or to the name of a group the member belongs to.

Parameters

No parameters required.

Permission

The member or an administrator can invoke this service.

Response

When there are groups visible to the user, the returned response lists the groups (in no particular order) using the extended representation of each group:

<groups>
  <group id="[id]" name="[name]" description="[description]" ... />
  ...
</groups>

When there aren’t any visible groups, the returned XML is:

<groups/>

XML example

<groups>
  <group id="123"
         name="acme-forum"
         description="Public forum of ACME Group"
         owner="ACME"
         access="member"
         common="false" 
         visibility="public"
         template="acme"
         editurls="false"
         commenting="contributor"
         moderation="email"
         registration="moderated"
         defaultrole="reviewer"
         defaultnotify="immediate"
         indexversion="9203">
    <message>You have been added to ACME's public forum.</message>
  </group>

  <group id="777"
         name="test-public"
         description="For testing"
         owner="PageSeeder"
         access="member"
         common="false"
         visibility="public"
         template="test"
         editurls="false"
         commenting="reviewer"
         moderation="email"
         registration="moderated"
         defaultrole="reviewer"
         defaultnotify="immediate" 
         indexversion="9203">
    <message>Welcome to the testing group!</message>
  </group>
</groups>

JSON example

{
  "groups": [
    {
      "id": 123,
      "name": "acme-forum",
      "type": "group",
      "description": "Public forum of ACME Group",
      "owner": "ACME",
      "access": "member",
      "common": false,
      "visibility": "public",
      "template": "acme",
      "editurls": false,
      "commenting": "contributor",
      "moderation": "email",
      "registration": "moderated",
      "defaultrole": "reviewer",
      "defaultnotify": "immediate",
      "indexversion": 9203,
      "message": "You have been added to ACME's public forum."
    },
    {
      "id": 777,
      "name": "test-public",
      "type": "group",
      "description": "For testing",
      "owner":"PageSeeder",
      "access":"member",
      "common": false,
      "visibility": "public",
      "template": "test",
      "editurls": false,
      "commenting": "reviewer",
      "moderation": "email",
      "registration": "moderated",
      "defaultrole": "reviewer",
      "defaultnotify": "immediate",
      "indexversion": 9203,
      "message": "Welcome to the testing group!"
    }
  ]
}

Error Handling