API Reference

Collections.getCollections

This method returns a list of collections from the specified vhost returned in a array. Each array will contain the collection information.

Syntax

bool collections.getCollections ( int vhost, int type = 0, mixed includeCount = false )

Arguments

Name	Type	Required	Default value	Description
vhost	int	Required	none	The ID of the vhost the collection belongs to.
type	int	Optional	0	The type of collections you want returned, 1 for manual, and 2 for saved search.
includeCount	mixed	Optional	false

Response

The response will be an array of items for each collection in the vhost. Each item will contain information about a collection.

Name	Type	Description	Default Values
id	INT	The collection ID	INT
vhost	INT	The vhost ID that the collection belongs to.	INT
thumbnail	STRING	A thumb url of an image to represent the collection.	empty STRING
type	INT	This determines whether the collection is a saved search collection or a manual collection. Saved search is represented by 1 and manual collection by 2.	1/2
name	STRING	The name of the collection. This is used for recognition of the channel.	STRING
description	STRING	An overview of the media content that is in the collection.	STRING
created	YYYY-MM-DD HH:MM:SS	The date the collection was created in our system.	YYYY-MM-DD HH:MM:SS
baseurl	STRING	DEPRECATED	STRING
channel	INT	The channel that is used as a filter if the collection type is a saved search.	empty / channel ID
addtotop	INT	When this is set the channel will be added to the top of the channel list.	0/1
autoactive	INT	This sets the collection that it will be set as published as its default state.	0/1

Sample Response

Sample REST Response
http://api.newspark.ca/services/rest/collections/getCollections?vhost=[VHOST_ID]&APIKEY=[APIKEY]

<?xml version="1.0" encoding="UTF-8"?>
<result>
  <item>
      <id>COLLECTION_ID</id>
      <vhost>VHOST_ID</vhost>
      <thumbnail/>
      <type>2</type>
      <name>COLLECTION_NAME</name>
      <description>Saved Collection Description</description>
      <created>2012-02-01 10:45:01</created>
      <baseurl/>
      <channel>FILTERED_CHANNEL_ID</channel>
      <addToTop>0</addToTop>
      <autoActive>1</autoActive>
  </item>
  <item>
      <id>COLLECTION_ID</id>
      <vhost>VHOST_ID</vhost>
      <thumbnail/>
      <type>2</type>
      <name>COLLECTION_NAME</name>
      <description>Saved Collection Description</description>
      <created>2012-02-01 10:45:01</created>
      <baseurl/>
      <channel>FILTERED_CHANNEL_ID</channel>
      <addToTop>0</addToTop>
      <autoActive>1</autoActive>
  </item>
</result>

Sample JSON Response

{
    "status": true,
    "result": [
        {
            "id": COLLECTION_ID,
            "vhost": VHOST_ID,
            "thumbnail": null,
            "type": 2,
            "name": "COLLECTION_NAME",
            "description": "Saved Collection Description",
            "created": "2012-02-01 10:45:01",
            "baseurl": null,
            "channel": FILTERED_CHANNEL_ID,
            "addToTop": 0,
            "autoActive": 1
        },
        {
            "id": COLLECTION_ID,
            "vhost": VHOST_ID,
            "thumbnail": null,
            "type": 2,
            "name": "COLLECTION_NAME",
            "description": "Saved Collection Description",
            "created": "2012-02-01 10:45:01",
            "baseurl": null,
            "channel": FILTERED_CHANNEL_ID,
            "addToTop": 0,
            "autoActive": 1

        }
    ]
}

Code examples

PHP-RPC

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

// Listing the arguments
$arguments = array(
  'APIKEY' => 'YOURAPIKEY',
  'method' => 'collections.getCollections',
  'vhost' => '2',
  'type' => $type,
  'includeCount' => $includeCount
);

// 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($includeCount)
);

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

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

$data = $client->call('collections.getCollections',$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 = "getCollections";
    myRemConn_rc.params = {2:vhost, type:type, includeCount:includeCount};
    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, includeCount);

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

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 getCollections ( type, includeCount ) {

var params = {
    "method" :      'collections.getCollections',
    "vhost" :       2,
    "type" :        type,
    "includeCount" : includeCount}

$.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->getCollections( 2, $type, $includeCount );

print_r($data);

0 comments

Be the first to comment on getCollections.

Developer Documentation Portal

API Reference

Collections.getCollections

Syntax

Arguments

Response

Sample Response

Sample REST Response
http://api.newspark.ca/services/rest/collections/getCollections?vhost=[VHOST_ID]&APIKEY=[APIKEY]

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

Collections.getCollections

Syntax

Arguments

Response

Sample Response

Sample REST Responsehttp://api.newspark.ca/services/rest/collections/getCollections?vhost=[VHOST_ID]&APIKEY=[APIKEY]

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/collections/getCollections?vhost=[VHOST_ID]&APIKEY=[APIKEY]