API Reference

Media.rateFile

Use this method to rate a media item on a scale.

When this method is accessed without the use of a API key, user ID is ignored and the current session is being used to determine the user id. A user can only rate once for every file. If the user attempts to vote again, the previous rating will be replaced.

If returnData = 1 then the data from getFileInfo will be returned. This is useful if you need to make further calculations on the new rating.

If returnData = 0 or is not included in the request only the rating value will be returned in the response.

Syntax

float media.rateFile ( int id, int rating, int uid = 0, bool returnData = false )

Arguments

Name	Type	Required	Default value	Description
id	int	Required	none	Id of the file you are rating.
rating	int	Required	none	The rating of the file. HAS to be a number between 1 and 10 (inclusive).
uid	int	Optional	0	Userid of the person making the rating.
returnData	bool	Optional	false	False (default) to get the rating, true to get the data from getFileInfo.

Response returnData = 1

If returnData = 1 we return all the file information returned from a media.getFileInfo service call. View the full response from the media.getFileInfo service.

Name	Type	Description
Error	The rating of the media item.	<error><message>Rating has to be an integer between 0 and 10 (inclusive)</message><type>Exception</type><code>0</code></error>

The rating of the file must always be included

If rating is not passed as a valid argument — a number between 0 and 10 an error will be returned.

Name	Description	Value
Success	The rating of the media item.	<result>10</result>
Error	The rating of the media item.	<error><message>Rating has to be an integer between 0 and 10 (inclusive)</message><type>Exception</type><code>0</code></error>

Response returnData returnData = 0 of removed from request URL

If returnData = 0 or is not included in the URL we will only return the rating of the media item you just sent the request for.

Name	Type	Description
result	INT	The rating of the media item.

Sample Response

Sample REST Response
http://api.newspark.ca/services/rest/media/rateFile?id=[MEDIA_ID]&rating=[RATING]&uid=[USER_ID]&returnData=0

<?xml version="1.0" encoding="UTF-8"?>
<result>RATING_SENT</result>

Sample JSON Response

{
    "status": true,
    "result": RATING_SENT
}

Sample REST Response
http://api.newspark.ca/services/rest/media/rateFile?id=[MEDIA_ID]&rating=[RATING]&uid=[USER_ID]&returnData=1

<?xml version="1.0" encoding="UTF-8"?>
<result>
  <id>MEDIA_ID</id>
  <status>3</status>
  <contenttype>image/png</contenttype>
  <filetype>1</filetype>
  <context>1</context>
  <filename>filemobile_llrdpzw4D11qzuk6wo1_500.png</filename>
  <injector>httpupload</injector>
  <hits>73</hits>
  <message>Test image upload</message>
  <date>2012-01-16 12:00:52</date>
  <title>Test image upload</title>
  <tags/>
  <extension>png</extension>
  <sender/>
  <author/>
  <metadata>a:1:{s:4:"user";a:1:{s:8:"demoMeta";s:17:"Test image upload";}}</metadata>
  <uid>USER_ID</uid>
  <filesize>272138</filesize>
  <ofilesize>127726</ofilesize>
  <upload>2012-01-16 12:00:52</upload>
  <location>fmdevs3</location>
  <originallocation/>
  <privacy>0</privacy>
  <moderationstatus>1</moderationstatus>
  <width>498</width>
  <height>282</height>
  <length>0.00</length>
  <conversiontime>3.09329</conversiontime>
  <converttime>2012-01-16 12:01:43</converttime>
  <lastupdatetime>2012-02-07 11:37:49</lastupdatetime>
  <offensive>0</offensive>
  <autoblog>0</autoblog>
  <rating>10</rating>
  <votecount>1</votecount>
  <externalid/>
  <parentid>0</parentid>
  <originalLocation/>
  <user_name>USER_NAME</user_name>
  <user_email>USER_EMAIL</user_email>
  <user_country>US</user_country>
  <user_city>asdfasdf</user_city>
  <user_state>CT</user_state>
  <user_nickname/>
  <user_firstname>FIRST_NAME</user_firstname>
  <user_lastname>LAST_NAME</user_lastname>
  <url/>
  <vhost>VHOST_ID</vhost>
  <rotation>0</rotation>
  <language/>
  <channel>CHANNEL_ID</channel>
  <channel_shortname>content</channel_shortname>
  <channel_name>Content</channel_name>
  <channelleft>1</channelleft>
  <geo_latitude>53.4842645684215</geo_latitude>
  <geo_longitude>-85.6796875</geo_longitude>
  <originalsaved>1</originalsaved>
  <hidden>SHOWN</hidden>
  <commentcount>2</commentcount>
  <approvedcomments>0</approvedcomments>
  <notdeniedcomments>2</notdeniedcomments>
  <publicUrl>http://fmdevs3.filemobile.com/storage/MEDIA_ID</publicUrl>
  <thumbUrl>http://fmdev.s3.amazonaws.com/storage/MEDIA_ID</thumbUrl>
  <moderationdeniedid>1</moderationdeniedid>
</result>

Sample JSON Response

{
    "status": true,
    "result": {
        "id": MEDIA_ID,
        "status": 3,
        "contenttype": "image/png",
        "filetype": 1,
        "context": 1,
        "filename": "filemobile_llrdpzw4D11qzuk6wo1_500.png",
        "injector": "httpupload",
        "hits": 73,
        "message": "Test image upload",
        "date": "2012-01-16 12:00:52",
        "title": "Test image upload",
        "tags": "",
        "extension": "png",
        "sender": "",
        "author": "",
        "metadata": "a:1:{s:4:\"user\";a:1:{s:8:\"demoMeta\";s:17:\"Test image upload\";}}",
        "uid": USER_ID,
        "filesize": 272138,
        "ofilesize": 127726,
        "upload": "2012-01-16 12:00:52",
        "location": "fmdevs3",
        "originallocation": "",
        "privacy": 0,
        "moderationstatus": 1,
        "width": 498,
        "height": 282,
        "length": "0.00",
        "conversiontime": "3.09329",
        "converttime": "2012-01-16 12:01:43",
        "lastupdatetime": "2012-02-07 12:37:49",
        "offensive": 0,
        "autoblog": "0",
        "rating": 10,
        "votecount": 1,
        "externalid": "",
        "parentid": 0,
        "originalLocation": "",
        "user_name": "USER_NAME",
        "user_email": "USER_EMAIL",
        "user_country": "US",
        "user_city": "asdfasdf",
        "user_state": "CT",
        "user_nickname": "",
        "user_firstname": "FIRSTNAME",
        "user_lastname": "LASTNAME",
        "url": "",
        "vhost": 228,
        "rotation": 0,
        "language": "",
        "channel": CHANNEL_ID,
        "channel_shortname": "content",
        "channel_name": "Content",
        "channelleft": 1,
        "geo_latitude": "53.4842645684215",
        "geo_longitude": "-85.6796875",
        "originalsaved": 1,
        "hidden": "SHOWN",
        "commentcount": 2,
        "approvedcomments": 0,
        "notdeniedcomments": 2,
        "publicUrl": "http://fmdevs3.filemobile.com/storage/MEDIA_ID",
        "thumbUrl": "http://fmdev.s3.amazonaws.com/storage/MEDIA_ID",
        "moderationdeniedid": 1
    }
}

Code examples

PHP-RPC

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

// Listing the arguments
$arguments = array(
  'APIKEY' => 'YOURAPIKEY',
  'method' => 'media.rateFile',
  'id' => $id,
  'rating' => $rating,
  'uid' => $uid,
  'returnData' => $returnData
);

// 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($rating),
  XML_RPC_encode($uid),
  XML_RPC_encode($returnData)
);

// Creating an XML-RPC message
$message = new XML_RPC_Message('media.rateFile',$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,
  $rating,
  $uid,
  $returnData
);

$data = $xmlrpc->invoke('media.rateFile',$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,
  $rating,
  $uid,
  $returnData
);

$data = $client->call('media.rateFile',$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 = "media";
    myRemConn_rc.methodName = "rateFile";
    myRemConn_rc.params = {id:id, rating:rating, uid:uid, returnData:returnData};
    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, rating, uid, returnData);

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

dim apiKey as string = "YOURAPIKEY"

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

' 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 rateFile ( id, rating, uid, returnData ) {

var params = {
    "method" :      'media.rateFile',
    "id" :          id,
    "rating" :      rating,
    "uid" :         uid,
    "returnData" :  returnData}

$.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->media->rateFile( $id, $rating, $uid, $returnData );

print_r($data);

0 comments

Be the first to comment on rateFile.

Developer Documentation Portal

API Reference

Media.rateFile

Syntax

Arguments

Response returnData = 1

The rating of the file must always be included

Response returnData returnData = 0 of removed from request URL

Sample Response

Sample REST Response
http://api.newspark.ca/services/rest/media/rateFile?id=[MEDIA_ID]&rating=[RATING]&uid=[USER_ID]&returnData=0

Sample JSON Response

Sample REST Response
http://api.newspark.ca/services/rest/media/rateFile?id=[MEDIA_ID]&rating=[RATING]&uid=[USER_ID]&returnData=1

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

Media.rateFile

Syntax

Arguments

Response returnData = 1

The rating of the file must always be included

Response returnData returnData = 0 of removed from request URL

Sample Response

Sample REST Responsehttp://api.newspark.ca/services/rest/media/rateFile?id=[MEDIA_ID]&rating=[RATING]&uid=[USER_ID]&returnData=0

Sample JSON Response

Sample REST Responsehttp://api.newspark.ca/services/rest/media/rateFile?id=[MEDIA_ID]&rating=[RATING]&uid=[USER_ID]&returnData=1

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/media/rateFile?id=[MEDIA_ID]&rating=[RATING]&uid=[USER_ID]&returnData=0

Sample REST Response
http://api.newspark.ca/services/rest/media/rateFile?id=[MEDIA_ID]&rating=[RATING]&uid=[USER_ID]&returnData=1