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

Name	Type	Required	Default value
id	mixed	Required	none
vhost	mixed	Optional	NULL
followingId	mixed	Optional	0

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

PHP-RPC

$path = 'https://api.newspark.ca/services/php';

// Listing the arguments
$arguments = array(
  'APIKEY' => 'YOURAPIKEY',
  'method' => 'users.getUserInfo',
  'id' => $id,
  'vhost' => '2',
  'followingId' => $followingId
);

// http_build_query basically turns an array into a url-encoded list of variables
$url = $path .'?' . http_build_query($arguments,null,'&');

// get the contents from the specified url
$data = file_get_contents($url);

// transform it back into php data structures
$data = unserialize($data);

// the actual data is stored in $data['result']

print_r($data['result']);

PEAR XMLRPC client

// Include the client
require_once 'XML/RPC.php';

// Create the XMLRPC Client
$client = new XML_RPC_Client('/services/xmlrpc?APIKEY={YOURAPIKEY}', 'api.newspark.ca');

// PEAR's XML-RPC client requires all arguments to wrapped in a special value class
// XML_RPC_encode converts this automatically

$arguments = array(
  XML_RPC_encode($id),
  XML_RPC_encode('2'),
  XML_RPC_encode($followingId)
);

// Creating an XML-RPC message
$message = new XML_RPC_Message('users.getUserInfo',$arguments);

// Sending the message to the server
$response = $client->send($message);

// We also need to decode the response back to normal PHP types
$response = XML_RPC_decode($response);

print_r($response);

SabreTooth XMLRPC client

// Include the client
require_once 'Sabre/XMLRPC/Client.php';

// Create the XMLRPC Client
$xmlrpc = new Sabre_XMLRPC_Client('https://api.newspark.ca/services/xmlrpc?APIKEY={YOURAPIKEY}');

$arguments = array(
  $id,
  '2',
  $followingId
);

$data = $xmlrpc->invoke('users.getUserInfo',$arguments);

print_r($data);

Zend XMLRPC client

// Include the client
require_once 'Zend/XmlRpc/Client.php';

// Create the XMLRPC Client
$client = new Zend_XmlRpc_Client('https://api.newspark.ca/services/xmlrpc?APIKEY={YOURAPIKEY}');

$arguments = array(
  $id,
  '2',
  $followingId
);

$data = $client->call('users.getUserInfo',$arguments);

print_r($data);

Actionscript 2

    /*
     *     In ActionScript 2 remote service calls are done using the RemotingConnector Component.
     *     An instance of the component must exist on the stage and have an instance name.
     *
     *     Results and Faults are handled by addEventListener's and the call parameters are placed inside of an associative array
     *
     *     You must also specify the service class and method names under the appropriate property fields of the component
     */

    var gatewayURL:String = "/services/amf2";
    //Set up service call
    myRemConn_rc.gatewayUrl = gatewayURL;
    myRemConn_rc.serviceName = "users";
    myRemConn_rc.methodName = "getUserInfo";
    myRemConn_rc.params = {id:id, 2:vhost, followingId:followingId};
    myRemConn_rc.addEventListener("result", widgetResult);
    myRemConn_rc.addEventListener("status", widgetFault);

    //Make the call
    myRemConn_rc.trigger();

    /*
    *  Handles service result.
    */
    function widgetResult(ev:Object){
        //Do stuff
        //Data is returned inside of ev.target.results
        //(i.e. ev.traget.results.description or ev.traget.results.settings.color)
    }

    /*
    *  Handles service fault.
    */
    function widgetFault(ev:Object){
        //Display Error
        trace("Categories Error - " + ev.code + " -  " + ev.data.faultstring);
    }

Actionscript 3

    /*
     *  In ActionScript 3 remote service calls are done using the NetConnection Object.
     *  A Responder Object controls what functions handle successful or failed calls
     *  and any parameters for the call are placed in an array and passed as a parameter
     *  in the NetConnection.call() method.
     */

    var gatewayURL:String = "/services/amf2";
    var parameters:Array = new Array(id, vhost, followingId);

    var connection:NetConnection = new NetConnection();
    connection.connect(gatewayURL);
    connection.call("users.getUserInfo", new Responder(widgetResult, widgetFault), parameters);


    /*
     *   Handles service result.
     */
    function widgetResult(ev:Object):void{
        //Do stuff
        //Data is returned inside of ev
        //(i.e. ev.description or ev.settings.color)
    }


    /*
    *  Handles service fault.
    */
    function widgetFault(ev:Object):void{
        //Display Error
        error.showError(parentClip, ev.code + " -  " + ev.description, "Please refresh your browser to try again.");
        error.x = (parentClip.width - error.width) / 2;
        error.y = (parentClip.height - error.height) / 2;
    }

REST service example

<%@ Page Language="vb" %>
<%


' REST gateway
dim gateway as string = "http://api.newspark.ca/services/rest/"

' Service + method we're calling.
dim method as string = "users/getUserInfo"

dim apiKey as string = "YOURAPIKEY"

dim url as string = gateway & method & "?APIKEY=" & apiKey &  "&id=" & id

' HTTP Client
dim wcHTTPScrape as new System.net.WebClient()

' Opening a stream
dim objInput as System.IO.Stream = wcHTTPScrape.OpenRead(url)

dim objReader as new System.IO.StreamReader ( objInput )

' Reading the entire HTTP response and output it
Response.Write ( objReader.ReadToEnd () )


objReader.Close ()
objInput.Close ()

%>

jQuery JSON

/*
* jQuery post example
*/

function getUserInfo ( id, followingId ) {

var params = {
    "method" :      'users.getUserInfo',
    "id" :          id,
    "vhost" :       2,
    "followingId" : followingId}

$.post('/services/json',params
,function(response){
    console.log(response);
});

Local API

// Get the Service Mapper

$mapper = Sabre_ServiceMap_Mapper::getMapper();

// Calling the method
$data = $mapper->users->getUserInfo( $id, 2, $followingId );

print_r($data);

0 comments

Be the first to comment on getUserInfo.

Developer Documentation Portal

API Reference

Users.getUserInfo

Syntax

Arguments

Sample Response

Sample REST Response
http://api.newspark.ca/services/rest/users/getUserInfo?vhost=[VHOST_ID]&id=[USER_ID]&APIKEY=[APIKEY]

Sample JSON Response

Code examples

PHP-RPC

PEAR XMLRPC client

SabreTooth XMLRPC client

Zend XMLRPC client

Actionscript 2

Actionscript 3

REST service example

jQuery JSON

Local API

0 comments

Add a Comment

Developer Documentation Portal

API Reference

Users.getUserInfo

Syntax

Arguments

Sample Response

Sample REST Responsehttp://api.newspark.ca/services/rest/users/getUserInfo?vhost=[VHOST_ID]&id=[USER_ID]&APIKEY=[APIKEY]

Sample JSON Response

Code examples

PHP-RPC

PEAR XMLRPC client

SabreTooth XMLRPC client

Zend XMLRPC client

Actionscript 2

Actionscript 3

REST service example

jQuery JSON

Local API

0 comments

Add a Comment

Sample REST Response
http://api.newspark.ca/services/rest/users/getUserInfo?vhost=[VHOST_ID]&id=[USER_ID]&APIKEY=[APIKEY]