API Reference

Users.getUserInfo

Returns information about a specific user.

This method returns all available information about a requested user based on either a user ID or a username. The method requires a user ID or a username. If a username is supplied the vhost parameter is required.


Syntax

mixed users.getUserInfo ( mixed id, mixed vhost = NULL, mixed followingId = 0 )

Arguments

NameTypeRequiredDefault valueDescription
idmixedRequirednone
vhostmixedOptionalNULL
followingIdmixedOptional0

Sample Response

Sample REST Response
http://api.newspark.ca/services/rest/users/getUserInfo?vhost=[VHOST_ID]&id=[USER_ID]&APIKEY=[APIKEY]
<?xml version="1.0" encoding="UTF-8"?>
<result>
  <id>USER_ID</id>
  <user>USER_NAME</user>
  <password>HASHED_USER_PASSWORD</password>
  <email>USER_EMAIL</email>
  <firstname>USER_FIRSTNAME</firstname>
  <lastname>USER_LASTNAME</lastname>
  <city>USER_CITY</city>
  <gender>M</gender>
  <birthdate>2011-02-01</birthdate>
  <cellphone>4162222222</cellphone>
  <phone>4162222222</phone>
  <website/>
  <occupation/>
  <address1>1 Toronto Road</address1>
  <address2/>
  <postalcode>M1M1M1</postalcode>
  <state>ON</state>
  <language/>
  <country>CA</country>
  <description/>
  <storage>0</storage>
  <avatar>0</avatar>
  <created>2012-02-03 14:48:50</created>
  <lastlogin>2012-02-03 16:30:11</lastlogin>
  <random1>5045</random1>
  <random2>151285996</random2>
  <accounttype>0</accounttype>
  <active>1</active>
  <disabled>0</disabled>
  <newsletter>0</newsletter>
  <openidurl/>
  <nickname/>
  <attempts>0</attempts>
  <mobileblog>0</mobileblog>
  <publicfiles>0</publicfiles>
  <unmoderatedfiles>0</unmoderatedfiles>
  <approvedfiles>0</approvedfiles>
  <deniedfiles>0</deniedfiles>
  <friends>1</friends>
  <friends_notconfirmed>0</friends_notconfirmed>
  <geo_latitude>41.83209336689739</geo_latitude>
  <geo_longitude>-84.44921875</geo_longitude>
  <vhost>VHOST_ID</vhost>
  <meta>
    <lang>en</lang>
    <twitterUserName/>
    <rules>1</rules>
  </meta>
  <no_comment_notifications>0</no_comment_notifications>
  <profile_complete>1</profile_complete>
  <externalids/>
</result>
Sample JSON Response
{
    "status": true,
    "result": {
        "id": USER_ID,
        "user": "USER_NAME",
        "password": "HASHED_USER_PASSWORD",
        "email": "USER_EMAIL",
        "firstname": "USER_FIRSTNAME",
        "lastname": "USER_LASTNAME",
        "city": "Toronto",
        "gender": "M",
        "birthdate": "2011-02-01",
        "cellphone": "4162222222",
        "phone": "4162222222",
        "website": "",
        "occupation": "",
        "address1": "1 Toronto Road",
        "address2": null,
        "postalcode": "M1M1M1",
        "state": "ON",
        "language": "",
        "country": "CA",
        "description": "",
        "storage": 0,
        "avatar": 0,
        "created": "2012-02-03 14:48:50",
        "lastlogin": "2012-02-03 16:30:11",
        "random1": 5045,
        "random2": 151285996,
        "accounttype": 0,
        "active": "1",
        "disabled": "0",
        "newsletter": "0",
        "openidurl": "",
        "nickname": "",
        "attempts": 0,
        "mobileblog": 0,
        "publicfiles": 0,
        "unmoderatedfiles": 0,
        "approvedfiles": 0,
        "deniedfiles": 0,
        "friends": 1,
        "friends_notconfirmed": 0,
        "geo_latitude": "41.83209336689739",
        "geo_longitude": "-84.44921875",
        "vhost": 231,
        "meta": {
            "lang": "en",
            "twitterUserName": "",
            "rules": "1"
        },
        "no_comment_notifications": 0,
        "profile_complete": 1,
        "externalids": {},
	"deviceinfo": 
            "0":  {
                    "id" : DEVICE_ID,
                    "uid" : USER_ID,
                    "vhost" : 239,
                    "device_id" : "04dbc117fbe284db71d3be1f37fe2e00fa13176da87f4e66de376606fdf05558",
                    "latitude" : "43.635872",
                    "longitude" : "-79.424721",
                    "lastupdatetime" : "2012-11-23 12:33:19",
                    "commentnotification" : 0,
                    "assignmentnotification" : 0,
                    "settings] : "a:1:{s:22:"notificationBadgeCount";s:1:"0";}"
                },
	    "1":  {
                    "id" : DEVICE_ID,
                    "uid" : USER_ID,
                    "vhost" : 239,
                    "device_id" : "14dbc117fbe284db71d3be1f37fe2e00fa13176da87f4e66de376606fdf05558",
                    "latitude" : "45.635872",
                    "longitude" : "-78.424721",
                    "lastupdatetime" : "2012-11-24 12:33:19",
                    "commentnotification" : 0,
                    "assignmentnotification" : 0,
                    "settings] : "a:1:{s:22:"notificationBadgeCount";s:1:"0";}"
                }
    }
}

Code examples

0 comments

Be the first to comment on getUserInfo.

Add a Comment

  • captcha