PeopleAggregator API: method peopleaggregator.getUserProfile

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

Method: peopleaggregator.getUserProfile

Returns a user's profile information.
User documentation for peopleaggregator.getUserProfile 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: myelin

Return value (see also Exceptions)

Type: hash

Attributes:

success

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

login

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

name

Type: string
User's full name.
Example: Phillip Pearson

id

Type: string
User's ID.
Example: user:26

url

Type: string
User's profile URL.
Example: http://example.org/peepagg/user/1234

profile

Type: hash
Full profile information.

Attributes:

general

Type: hash
basic profile information.

Attributes:

dob

Type: date
date of birth
Example: 1980-03-22

Example REST (XML) request

Request

GET /api/xml/peopleaggregator/getUserProfile?login=myelin HTTP/1.1

Response

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

<response>
 <profile>
  <general>
   <dob>1980-03-22</dob>
  </general>
 </profile>
 <name>Phillip Pearson</name>
 <success>true</success>
 <url>http://example.org/peepagg/user/1234</url>
 <login>myelin</login>
 <id>user:26</id>
</response>

Example REST (JSON) request

Request

GET /api/json/peopleaggregator/getUserProfile?login=myelin HTTP/1.1

Response

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

{"profile": {"general": {"dob": "1980-03-22"}}, "name": "Phillip Pearson", "success": true, "url": "http://example.org/peepagg/user/1234", "login": "myelin", "id": "user:26"}

Example XML-RPC call

Request

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

<?xml version='1.0'?>
 <methodCall>
  <methodName>peopleaggregator.getUserProfile</methodName>
  <params>
   <param>
    <value><struct>
     <member>
      <name>login</name>
      <value><string>myelin</string></value>
     </member>
    </struct></value>
   </param>
  </params>
 </methodCall>
 

Response

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

<?xml version='1.0'?>
 <methodResponse>
  <params>
   <param>
    <value><struct>
     <member>
      <name>profile</name>
      <value><struct>
       <member>
        <name>general</name>
        <value><struct>
         <member>
          <name>dob</name>
          <value><string>1980-03-22</string></value>
         </member>
        </struct></value>
       </member>
      </struct></value>
     </member>
     <member>
      <name>name</name>
      <value><string>Phillip Pearson</string></value>
     </member>
     <member>
      <name>success</name>
      <value><boolean>1</boolean></value>
     </member>
     <member>
      <name>url</name>
      <value><string>http://example.org/peepagg/user/1234</string></value>
     </member>
     <member>
      <name>login</name>
      <value><string>myelin</string></value>
     </member>
     <member>
      <name>id</name>
      <value><string>user:26</string></value>
     </member>
    </struct></value>
   </param>
  </params>
 </methodResponse>