API Reference

Friends.getFriends

Returns an array of friends for the specified user ID along with the users basic user information.

Syntax

array friends.getFriends ( int uid = 1, array statuses = array(), int start = 0, int count = 50 )

Arguments

Name	Type	Required	Default value	Description
uid	int	Optional	1	The user ID you want their friends returned back to you.
statuses	array	Optional	array()	list of statuses you want returned.
start	int	Optional	0	Starting location of list of friends to return
count	int	Optional	50	Amount of users to have returned default 50

Response

This is the content of the array for each user that will be returned on success of the request.

Name	Type	Description
id	INT	The ID of the user.
friendstatus	INT	The friend status between the supplied user ID and the returned user. Possible values are 2 = friendship requested (status from user1 perspective is waiting, status from user2 perspective is notconfirmed) and 3 = confirmed (friendship status is confirmed).
user	STRING	The username of the users friend.
website	STRING	The website of the users friend.
firstname	STRING	The firstname of the users friend.
lastname	STRING	The lastname of the users friend.
nickname	STRING	The nickname of the users friend.
country	STRING	The 2-letter country code of the users friend.
avatar	INT	The ID of the friend's avatar.

Sample Response

Code examples

PHP-RPC

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

// Listing the arguments
$arguments = array(
  'APIKEY' => 'YOURAPIKEY',
  'method' => 'friends.getFriends',
  'uid' => $uid,
  'statuses' => $statuses,
  'start' => $start,
  'count' => $count
);

// 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($uid),
  XML_RPC_encode($statuses),
  XML_RPC_encode($start),
  XML_RPC_encode($count)
);

// Creating an XML-RPC message
$message = new XML_RPC_Message('friends.getFriends',$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(
  $uid,
  $statuses,
  $start,
  $count
);

$data = $xmlrpc->invoke('friends.getFriends',$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(
  $uid,
  $statuses,
  $start,
  $count
);

$data = $client->call('friends.getFriends',$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 = "friends";
    myRemConn_rc.methodName = "getFriends";
    myRemConn_rc.params = {uid:uid, statuses:statuses, start:start, count:count};
    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(uid, statuses, start, count);

    var connection:NetConnection = new NetConnection();
    connection.connect(gatewayURL);
    connection.call("friends.getFriends", 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 = "friends/getFriends"

dim apiKey as string = "YOURAPIKEY"

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

' 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 getFriends ( uid, statuses, start, count ) {

var params = {
    "method" :      'friends.getFriends',
    "uid" :         uid,
    "statuses" :    statuses,
    "start" :       start,
    "count" :       count}

$.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->friends->getFriends( $uid, $statuses, $start, $count );

print_r($data);

0 comments

Be the first to comment on getFriends.

Developer Documentation Portal