API Reference

Collections.updateSearchCollection

This method is used to update a saved search collection.

The settings argument is an array of media ID's in the collection and the new order that they should be returned to in from this point forward.

The collection name and description can be changed with the updateCollectionInfo method.

Syntax

bool collections.updateSearchCollection ( int collection, array settings )

Arguments

Name	Type	Required	Default value	Description
collection	int	Required	none	The collection ID.
settings	array	Required	none	The array of fields to be updated.

Settings Array

The collection fields that can be updated.

Name	Type	Description	Default Values	Possible Values	Required
filetype	INT OR ARRAY of INT	Only include the specified file types when adding media into the saved search collection.	empty(all)	empty,0,1,2,3,4	required
sort	STRING	The sort order of to apply to the media in the collection when returned in a request.	upload	upload, hits, commentcount, rating, votecount	required
channel	INT	We channel that will be used to filter media from. Only media in the specified channel will be returned. You can also specify if you want to include media from children channel of the one selected.	empty	INT	required
sortdir	STRING	The order which the sort filter will be applied. Ascending or descending order	ASC / DESC	STRING	no
includeChildChannels	STRING	This specifies if media from the above channel's children will be returned in the response.	false	true / false	no
timelimit	INT	A filter to only return media uploaded from a specific amount of time in the past. For example to specify media uploaded in the last 24 hours we would use 3600. (24 hr = 3600 sec)	empty	INT	no
limit	STRING	The maximum number of media to be returned during a request.	25	STRING	no
limitSelect	BOOL	Used to turn on and off the limit field.	BOOL	no
query	STRING	A string to filter media by.	empty	STRING	no

Response

The response will be 1 if the update was a success.

Name	Type	Description	Default Values
id	INT	The success result will be 1 if the update was completed.	INT

Sample Response

Sample REST Response
http://api.newspark.ca/services/rest/collections/updateSearchCollection?collection=[COLLECTION_ID]&settings[filetype]=1&settings[channel]=[CHANNEL_ID]&settings[sort]=[NEW_SORT_PARAM]&settings[sortdir]=[SORT_DIRECTION]&settings[includeChildChannels]=true&settings[limit]=5&settings[limitSelect]=false&settings[query]=[QUERY_VALUE]&settings[timelimit]=8000&APIKEY=[APIKEY]

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

Sample JSON Response

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

Code examples

PHP-RPC

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

// Listing the arguments
$arguments = array(
  'APIKEY' => 'YOURAPIKEY',
  'method' => 'collections.updateSearchCollection',
  'collection' => $collection,
  'settings' => $settings
);

// 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($collection),
  XML_RPC_encode($settings)
);

// Creating an XML-RPC message
$message = new XML_RPC_Message('collections.updateSearchCollection',$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(
  $collection,
  $settings
);

$data = $xmlrpc->invoke('collections.updateSearchCollection',$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(
  $collection,
  $settings
);

$data = $client->call('collections.updateSearchCollection',$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 = "collections";
    myRemConn_rc.methodName = "updateSearchCollection";
    myRemConn_rc.params = {collection:collection, settings:settings};
    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(collection, settings);

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

dim apiKey as string = "YOURAPIKEY"

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

' 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 updateSearchCollection ( collection, settings ) {

var params = {
    "method" :      'collections.updateSearchCollection',
    "collection" :  collection,
    "settings" :    settings}

$.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->collections->updateSearchCollection( $collection, $settings );

print_r($data);

0 comments

Be the first to comment on updateSearchCollection.

Developer Documentation Portal