Returns information about a specific channel.
The ID argument can be specified by the channel ID or the channel shortname. If the channel shortname is used the vhost argument is required.
Sample REST Response
http://api.newspark.ca/services/rest/channels/getChannelInfo?vhost=[VHOST_ID]&id=[CHANNEL_ID]
<?xml version="1.0" encoding="UTF-8"?>
<result>
<id>CHANNEL_ID</id>
<created>2012-01-20 12:08:57</created>
<vhost>VHOST_ID</vhost>
<name>Comments</name>
<shortname>comments</shortname>
<parentchannel>0</parentchannel>
<thumburl/>
<status>1</status>
<description/>
<readonly>0</readonly>
<disableembed>0</disableembed>
<modemailaccepted>0</modemailaccepted>
<modemaildenied>0</modemaildenied>
<emailaddress/>
<visibility>1</visibility>
<treeleft>11</treeleft>
<treeright>12</treeright>
<defaultsort>upload DESC</defaultsort>
<geoblocking/>
</result>
Sample JSON Response
{
"status": true,
"result": {
"id": CHANNEL_ID,
"created": "2012-01-20 12:08:57",
"vhost": VHOST_ID,
"name": "Comments",
"shortname": "comments",
"parentchannel": 0,
"thumburl": "",
"status": 1,
"description": "",
"readonly": "0",
"disableembed": "0",
"modemailaccepted": 0,
"modemaildenied": 0,
"emailaddress": null,
"visibility": 1,
"treeleft": 11,
"treeright": 12,
"defaultsort": "upload DESC",
"geoblocking": []
}
}
PHP-RPC
$path = 'https://api.newspark.ca/services/php';
// Listing the arguments
$arguments = array(
'APIKEY' => 'YOURAPIKEY',
'method' => 'channels.getChannelInfo',
'id' => $id,
'vhost' => '2'
);
// 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($id),
XML_RPC_encode('2')
);
// Creating an XML-RPC message
$message = new XML_RPC_Message('channels.getChannelInfo',$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(
$id,
'2'
);
$data = $xmlrpc->invoke('channels.getChannelInfo',$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(
$id,
'2'
);
$data = $client->call('channels.getChannelInfo',$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 = "channels";
myRemConn_rc.methodName = "getChannelInfo";
myRemConn_rc.params = {id:id, 2:vhost};
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(id, vhost);
var connection:NetConnection = new NetConnection();
connection.connect(gatewayURL);
connection.call("channels.getChannelInfo", 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 = "channels/getChannelInfo"
dim apiKey as string = "YOURAPIKEY"
dim url as string = gateway & method & "?APIKEY=" & apiKey & "&id=" & id
' 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 getChannelInfo ( id ) {
var params = {
"method" : 'channels.getChannelInfo',
"id" : id,
"vhost" : 2}
$.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->channels->getChannelInfo( $id, 2 );
print_r($data);
back to top
