PeopleAggregator API: method peopleaggregator.getUserRelations

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

Method: peopleaggregator.getUserRelations

Returns a user's friends and other relations.
User documentation for peopleaggregator.getUserRelations 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:

login

Type: string
User's login name.
Example: marc

profileImageSize

Type: enum
Dimensions of profile images to return (for detailLevel 'pics' or above)
Allowed values: 50x50, 127x135, full
Example: 50x50
Default: full

page

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

resultsPerPage

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

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 relations 1-12 for user marc

login

Type: string
User's login name.
Example: marc

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 as the 'page' variable, you will receive the final page in the result set.
Example: 2

relations

Type: array

Content of each item:

item

Type: hash

Attributes:

id

Type: string
ID of related user.
Example: user:42

login

Type: string
Relation's login name.
Example: marccanter

relation

Type: enum
The type of relationship.
Allowed values: havent met, acquaintance, relation, good relation, best relation
Example: relation

url

Type: string
Relation's profile URL.
Example: http://example.org/peepagg/user/12345

image

Type: hash
Relation's profile image (returned for detailLevel 'pics' or above).

Attributes:

url

Type: string
URL of relation's profile image
Example: http://example.org/peepagg/files/12345_image.jpg

width

Type: int
Width of relation's profile image
Example: 420

height

Type: int
Height of relation's profile image
Example: 960

Example REST (XML) request

Request

GET /api/xml/peopleaggregator/getUserRelations?profileImageSize=50x50&login=marc&resultsPerPage=12&page=2 HTTP/1.1

Response

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

<response>
 <success>true</success>
 <relations>
  <item>
   <url>http://example.org/peepagg/user/12345</url>
   <login>marccanter</login>
   <relation>relation</relation>
   <id>user:42</id>
   <image>
    <url>http://example.org/peepagg/files/12345_image.jpg</url>
    <width>420</width>
    <height>960</height>
   </image>
  </item>
 </relations>
 <totalPages>2</totalPages>
 <resultsPerPage>50</resultsPerPage>
 <msg>Retrieved relations 1-12 for user marc</msg>
 <login>marc</login>
 <totalResults>51</totalResults>
 <page>2</page>
</response>

Example REST (JSON) request

Request

GET /api/json/peopleaggregator/getUserRelations?profileImageSize=50x50&login=marc&resultsPerPage=12&page=2 HTTP/1.1

Response

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

{"success": true, "relations": [{"url": "http://example.org/peepagg/user/12345", "login": "marccanter", "relation": "relation", "id": "user:42", "image": {"url": "http://example.org/peepagg/files/12345_image.jpg", "width": 420, "height": 960}}], "totalPages": 2, "resultsPerPage": 50, "msg": "Retrieved relations 1-12 for user marc", "login": "marc", "totalResults": 51, "page": 2}

Example XML-RPC call

Request

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

<?xml version='1.0'?>
 <methodCall>
  <methodName>peopleaggregator.getUserRelations</methodName>
  <params>
   <param>
    <value><struct>
     <member>
      <name>profileImageSize</name>
      <value><string>50x50</string></value>
     </member>
     <member>
      <name>login</name>
      <value><string>marc</string></value>
     </member>
     <member>
      <name>resultsPerPage</name>
      <value><int>12</int></value>
     </member>
     <member>
      <name>page</name>
      <value><int>2</int></value>
     </member>
    </struct></value>
   </param>
  </params>
 </methodCall>
 

Response

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

<?xml version='1.0'?>
 <methodResponse>
  <params>
   <param>
    <value><struct>
     <member>
      <name>success</name>
      <value><boolean>1</boolean></value>
     </member>
     <member>
      <name>relations</name>
      <value><array><data>
       <value><struct>
        <member>
         <name>url</name>
         <value><string>http://example.org/peepagg/user/12345</string></value>
        </member>
        <member>
         <name>login</name>
         <value><string>marccanter</string></value>
        </member>
        <member>
         <name>relation</name>
         <value><string>relation</string></value>
        </member>
        <member>
         <name>id</name>
         <value><string>user:42</string></value>
        </member>
        <member>
         <name>image</name>
         <value><struct>
          <member>
           <name>url</name>
           <value><string>http://example.org/peepagg/files/12345_image.jpg</string></value>
          </member>
          <member>
           <name>width</name>
           <value><int>420</int></value>
          </member>
          <member>
           <name>height</name>
           <value><int>960</int></value>
          </member>
         </struct></value>
        </member>
       </struct></value>
      </data></array></value>
     </member>
     <member>
      <name>totalPages</name>
      <value><int>2</int></value>
     </member>
     <member>
      <name>resultsPerPage</name>
      <value><int>50</int></value>
     </member>
     <member>
      <name>msg</name>
      <value><string>Retrieved relations 1-12 for user marc</string></value>
     </member>
     <member>
      <name>login</name>
      <value><string>marc</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>