PeopleAggregator API: method peopleaggregator.getCategories

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

Method: peopleaggregator.getCategories

Returns the list of categories in the system.
User documentation for peopleaggregator.getCategories 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:

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 categories 1-12.

totalResults

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

categories

Type: array

Content of each item:

item

Type: hash

Attributes:

id

Type: string
Category ID
Example: cat:42

name

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

groupCount

Type: int
The number of groups in this category.
Example: 42

Example REST (XML) request

Request

GET /api/xml/peopleaggregator/getCategories? HTTP/1.1

Response

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

<response>
 <msg>Retrieved categories 1-12.</msg>
 <totalResults>51</totalResults>
 <categories>
  <item>
   <groupCount>42</groupCount>
   <id>cat:42</id>
   <name>QA feedback.</name>
  </item>
 </categories>
 <success>true</success>
</response>

Example REST (JSON) request

Request

GET /api/json/peopleaggregator/getCategories? HTTP/1.1

Response

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

{"msg": "Retrieved categories 1-12.", "totalResults": 51, "categories": [{"groupCount": 42, "id": "cat:42", "name": "QA feedback."}], "success": true}

Example XML-RPC call

Request

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

<?xml version='1.0'?>
 <methodCall>
  <methodName>peopleaggregator.getCategories</methodName>
  <params>
   <param>
    <value><struct>
    </struct></value>
   </param>
  </params>
 </methodCall>
 

Response

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

<?xml version='1.0'?>
 <methodResponse>
  <params>
   <param>
    <value><struct>
     <member>
      <name>msg</name>
      <value><string>Retrieved categories 1-12.</string></value>
     </member>
     <member>
      <name>totalResults</name>
      <value><int>51</int></value>
     </member>
     <member>
      <name>categories</name>
      <value><array><data>
       <value><struct>
        <member>
         <name>groupCount</name>
         <value><int>42</int></value>
        </member>
        <member>
         <name>id</name>
         <value><string>cat:42</string></value>
        </member>
        <member>
         <name>name</name>
         <value><string>QA feedback.</string></value>
        </member>
       </struct></value>
      </data></array></value>
     </member>
     <member>
      <name>success</name>
      <value><boolean>1</boolean></value>
     </member>
    </struct></value>
   </param>
  </params>
 </methodResponse>