API Reference

Users.getPowerUserRanking

If bylike is set to False.

This method will return a list of users, sorted by their submissions over 7 or 30 days.

f bylike is set to True

This method will return a list of users, sorted by amount of likes on their submissions over 7 or 30 days.

Syntax

array users.getPowerUserRanking ( int vhost, int type = 30, int limit = 15, int offset = 0, mixed bylike = false )

Arguments

Name	Type	Required	Default value	Description
vhost	int	Required	none	ID of the application that the media is in.
type	int	Optional	30	7 or 30, others will not work, Default: 30
limit	int	Optional	15	Amount of records to return, Default 15
offset	int	Optional	0	Where to start returning records from. Default 0(First Record)
bylike	mixed	Optional	false

Response

Description of returned fields

Name	Type	Description
date	DATE	The date of the users last upload.
uid	INT	The user's id.
videos	INT	Amount of videos the user has uploaded over the previous 32 days.
photos	INT	Amount of photos the user has uploaded over the previous 30 days.
totalmedialast30	INT	Total amount of media the user has uploaded over the previous 30 days.
totalmedialast7	INT	Total amount of media the user has uploaded over the previous 7 days
plusminus	INT	Today's plus/minus over the last 30 days
rank	INT	The user's overall rank.

Sample Response

Code examples

PHP-RPC

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

// Listing the arguments
$arguments = array(
  'APIKEY' => 'YOURAPIKEY',
  'method' => 'users.getPowerUserRanking',
  'vhost' => '2',
  'type' => $type,
  'limit' => $limit,
  'offset' => $offset,
  'bylike' => $bylike
);

// 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('2'),
  XML_RPC_encode($type),
  XML_RPC_encode($limit),
  XML_RPC_encode($offset),
  XML_RPC_encode($bylike)
);

// Creating an XML-RPC message
$message = new XML_RPC_Message('users.getPowerUserRanking',$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(
  '2',
  $type,
  $limit,
  $offset,
  $bylike
);

$data = $xmlrpc->invoke('users.getPowerUserRanking',$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(
  '2',
  $type,
  $limit,
  $offset,
  $bylike
);

$data = $client->call('users.getPowerUserRanking',$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 = "getPowerUserRanking";
    myRemConn_rc.params = {2:vhost, type:type, limit:limit, offset:offset, bylike:bylike};
    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(vhost, type, limit, offset, bylike);

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

dim apiKey as string = "YOURAPIKEY"

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

' 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 getPowerUserRanking ( type, limit, offset, bylike ) {

var params = {
    "method" :      'users.getPowerUserRanking',
    "vhost" :       2,
    "type" :        type,
    "limit" :       limit,
    "offset" :      offset,
    "bylike" :      bylike}

$.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->getPowerUserRanking( 2, $type, $limit, $offset, $bylike );

print_r($data);

0 comments

Be the first to comment on getPowerUserRanking.

Developer Documentation Portal