PeopleAggregator API: method peopleaggregator.getGroups

Arguments | Return value | REST (XML) example | REST (JSON) example | XML-RPC example

Method: peopleaggregator.getGroups

Returns the list of groups in the system.
User documentation for peopleaggregator.getGroups on the PeopleAggregator wiki

Arguments (see also Authentication)

If calling by XML-RPC, note that this method takes a single struct as input, with the following keys:

page

Type: int
Page of relations to return. The first page is page 1.
Example: 1
Minimum: 1
Default: 1

resultsPerPage

Type: int
How many relations you want to receive per "page".
Example: 12
Minimum: 10
Maximum: 100
Default: 100

context

Type: string
The context from which to retrieve content: specify 'global' to retrieve the global group list, 'user:123' to retrieve user #123's group memberships, or [FIXME - not implemented yet] 'tag:123' to retrieve groups with tag #123.
Example: user:26
Default: global

Return value (see also Exceptions)

Type: hash

Attributes:

success

Type: boolean
True on success, false on failure.
Example: True

msg

Type: string
Human-readable status message
Example: Retrieved groups 1-12.

page

Type: int
The current page of results.
Example: 2

resultsPerPage

Type: int
Number of results returned per page.
Example: 50
Default: 100

totalResults

Type: int
Total number of bugs in result set.
Example: 51

totalPages

Type: int
Total number of pages in result set. If you pass this back in as the 'page' variable, you will receive the final page in the result set.
Example: 2

groups

Type: array

Content of each item:

item

Type: hash

Attributes:

id

Type: string
Group's database ID
Example: group:42

name

Type: string
The name of the group.
Example: QA feedback.

memberCount

Type: int
The number of members in the group.
Example: 12

url

Type: string
URL of the group.
Example: http://peopleaggregator.net/group.php?gid=42

Example REST (XML) request

Request

GET /api/xml/peopleaggregator/getGroups?resultsPerPage=12&page=1&context=user%3A26 HTTP/1.1

Response

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: 719

<response>
 <success>true</success>
 <totalPages>2</totalPages>
 <resultsPerPage>50</resultsPerPage>
 <groups>
  <item>
   <memberCount>12</memberCount>
   <url>http://peopleaggregator.net/group.php?gid=42</url>
   <id>group:42</id>
   <name>QA feedback.</name>
  </item>
 </groups>
 <msg>Retrieved groups 1-12.</msg>
 <totalResults>51</totalResults>
 <page>2</page>
</response>

Example REST (JSON) request

Request

GET /api/json/peopleaggregator/getGroups?resultsPerPage=12&page=1&context=user%3A26 HTTP/1.1

Response

HTTP/1.1 200 OK
Content-Type: application/x-javascript
Content-Length: 250

{"success": true, "totalPages": 2, "resultsPerPage": 50, "groups": [{"memberCount": 12, "url": "http://peopleaggregator.net/group.php?gid=42", "id": "group:42", "name": "QA feedback."}], "msg": "Retrieved groups 1-12.", "totalResults": 51, "page": 2}

Example XML-RPC call

Request

POST /api/xmlrpc HTTP/1.1
Content-Type: text/xml
Content-Length: 1236

<?xml version='1.0'?>
 <methodCall>
  <methodName>peopleaggregator.getGroups</methodName>
  <params>
   <param>
    <value><struct>
     <member>
      <name>resultsPerPage</name>
      <value><int>12</int></value>
     </member>
     <member>
      <name>page</name>
      <value><int>1</int></value>
     </member>
     <member>
      <name>context</name>
      <value><string>user:26</string></value>
     </member>
    </struct></value>
   </param>
  </params>
 </methodCall>
 

Response

HTTP/1.1 200 OK
Content-Type: text/xml
Content-Length: 3882

<?xml version='1.0'?>
 <methodResponse>
  <params>
   <param>
    <value><struct>
     <member>
      <name>success</name>
      <value><boolean>1</boolean></value>
     </member>
     <member>
      <name>totalPages</name>
      <value><int>2</int></value>
     </member>
     <member>
      <name>resultsPerPage</name>
      <value><int>50</int></value>
     </member>
     <member>
      <name>groups</name>
      <value><array><data>
       <value><struct>
        <member>
         <name>memberCount</name>
         <value><int>12</int></value>
        </member>
        <member>
         <name>url</name>
         <value><string>http://peopleaggregator.net/group.php?gid=42</string></value>
        </member>
        <member>
         <name>id</name>
         <value><string>group:42</string></value>
        </member>
        <member>
         <name>name</name>
         <value><string>QA feedback.</string></value>
        </member>
       </struct></value>
      </data></array></value>
     </member>
     <member>
      <name>msg</name>
      <value><string>Retrieved groups 1-12.</string></value>
     </member>
     <member>
      <name>totalResults</name>
      <value><int>51</int></value>
     </member>
     <member>
      <name>page</name>
      <value><int>2</int></value>
     </member>
    </struct></value>
   </param>
  </params>
 </methodResponse>