API Reference

Geo.getMediaFromArea

This function returns media for a square area defined by the $northEast and $southWest tips of the square.

Syntax

mixed geo.getMediaFromArea ( int vhost, array northEast, array southWest, int moderationStatus = false )

Arguments

Name	Type	Required	Default value	Description
vhost	int	Required	none	The vhost of the application.
northEast	array	Required	none	The north-east (upper-right) point of the square that defines the area for the media. Along with $southWest, is provides the co-ordinates for the area that is to show the users. Examle: $northEast[0] => 62.865220228976895, $northEast[1] => -52.44921875
southWest	array	Required	none	The south-west (lower-left) point of the square that defines the area for the media. Along with $northEast, is provides the co-ordinates for the area that is to show the users. Examle: $southWest[0] => 35.08404808848904, $southWest[1] => -131.55078125
moderationStatus	int	Optional	false	The moderationstatus of the media to be displayed. Possible values: 0 (unmoderated), 1 (accepted/approved), 2 (denied), 3 (notdenied), -1 (all)

Response

Below are the fields available in the returned array.

Name	Type	Description
filetype	INT	The filetype of the media: 1 = image, 2 = video, 3 = audio, 4 = text.
hits	INT	The number of views for the media.
title	STRING	The media title.
geo_latitude	FLOAT	The event's geographical latitude. i.e.: 40.775729609144044
geo_longitude	FLOAT	The event's geographical longitude. i.e.: -84.44921875
thumbUrl	STRING	The address of the event.

Sample Response

Code examples

PHP-RPC

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

// Listing the arguments
$arguments = array(
  'APIKEY' => 'YOURAPIKEY',
  'method' => 'geo.getMediaFromArea',
  'vhost' => '2',
  'northEast' => $northEast,
  'southWest' => $southWest,
  'moderationStatus' => $moderationStatus
);

// 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($northEast),
  XML_RPC_encode($southWest),
  XML_RPC_encode($moderationStatus)
);

// Creating an XML-RPC message
$message = new XML_RPC_Message('geo.getMediaFromArea',$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',
  $northEast,
  $southWest,
  $moderationStatus
);

$data = $xmlrpc->invoke('geo.getMediaFromArea',$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',
  $northEast,
  $southWest,
  $moderationStatus
);

$data = $client->call('geo.getMediaFromArea',$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 = "geo";
    myRemConn_rc.methodName = "getMediaFromArea";
    myRemConn_rc.params = {2:vhost, northEast:northEast, southWest:southWest, moderationStatus:moderationStatus};
    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, northEast, southWest, moderationStatus);

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

dim apiKey as string = "YOURAPIKEY"

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

' 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 getMediaFromArea ( northEast, southWest, moderationStatus ) {

var params = {
    "method" :      'geo.getMediaFromArea',
    "vhost" :       2,
    "northEast" :   northEast,
    "southWest" :   southWest,
    "moderationStatus" : moderationStatus}

$.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->geo->getMediaFromArea( 2, $northEast, $southWest, $moderationStatus );

print_r($data);

0 comments

Be the first to comment on getMediaFromArea.

Developer Documentation Portal