This method returns a list of collections from the specified vhost returned in a array. Each array will contain the collection information.
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
}
]
}
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']);
back to topPEAR 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);back to topSabreTooth 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);back to topZend 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);back to topActionscript 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);
}back to topActionscript 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;
}back to topREST 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 ()
%>
back to topjQuery 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);
});
back to topLocal API
// Get the Service Mapper
$mapper = Sabre_ServiceMap_Mapper::getMapper();
// Calling the method
$data = $mapper->collections->getCollections( 2, $type, $includeCount );
print_r($data);
back to top
