API Reference

System.multicall

This method allows you to wrap multiple methodcalls in one service request. This method is compatible with the XML-RPC multicall specification.

Every request should be struct with a "methodName" and a "params" key. The "params" array may not be an associative array, it must be anindexed array. This means that you must provide each parameter in its correct order to the services you are calling.

An example of the REST request syntax is below.

Sample JSON Multical Request

var params = {
    "method" : 'system.multicall',
    "requests" : [{
        "methodName" : "media.getFiles",
        "params" : {
            "vhost" : [VHOST_ID],
            "sort"  : "",
            "filters" : {
                "channel" : [CHANNEL_ID]
            },
            "start" : "",
            "limit" : 2
        }
    },
    {
        "methodName" : "users.getUsers",
        "params" : {
            "vhost" : [VHOST_ID],
            "filters" : {
                "active" : "true"
            },
            "offset" : "",
            "limit" : "10",
            "fields" : ["firstname","lastname","email"],
            "sort" : "created DESC",
            "getExternalIds" : ""
        }
    },
    {
        "methodName" : "groups.createGroup",
        "params" : {
            "vhost" : [VHOST_ID],
            "name" : "New Group Name",
            "additionalInfo" : {
                "email" : "[USER_EMAIL_ADDRESS_REQUIRED]"
            }
        }
    }],
    "APIKEY" : "[APIKEY]"
}

$.post('/services/json',params
,function(response){
    console.log(response);
});

Syntax

array system.multicall ( array requests )

Arguments

Name	Type	Required	Default value	Description
requests	array	Required	none	This is an array of service calls that are going to be made using the multicall service.

Sample Response

Sample REST Response

http://api.newspark.ca/services/rest/system/multicall?
requests[0][methodName]=media.getFiles&
    requests[0][params][vhost]=[VHOST_ID]&
    requests[0][params][sort]=&
    requests[0][params][filters][channel]=[CHANNEL_ID]&
    requests[0][params][start]=&
    requests[0][params][limit]=2&
requests[1][methodName]=users.getUsers&
    requests[1][params][vhost]=[VHOST_ID]&
requests[2][methodName]=groups.createGroup&
    requests[2][params][vhost]=[VHOST_ID]&
    requests[2][params][name]=[NEW_GROUP_NAME]&
    requests[2][params][additionalInfo][email]=[USER_EMAIL_ADDRESS]&
APIKEY=[APIKEY]

<?xml version="1.0" encoding="UTF-8"?>
<result>
  <item>
    <item>
      <totalCount>2</totalCount>
      <data>
        <item>
          <avatar>0</avatar>
          <channel>CHANNEL_ID</channel>
          <commentcount>0</commentcount>
          <filetype>1</filetype>
          <hits>47</hits>
          <id>MEDIA_ID</id>
          <message>MEDIA_DESCRIPTION</message>
          <rating>0</rating>
          <status>3</status>
          <tags>these are media tags</tags>
          <title>MEDIA_TITLE</title>
          <uid>USER_ID</uid>
          <upload>2012-01-25 16:36:47</upload>
          <user_name>USER_NAME</user_name>
          <vhost>VHOST_ID</vhost>
          <votecount>0</votecount>
          <publicUrl>http://fmdevs3.filemobile.com/storage/MEDIA_ID</publicUrl>
          <thumbUrl>http://fmdev.s3.amazonaws.com/storage/MEDIA_ID</thumbUrl>
          <location>fmdevs3</location>
        </item>
        <item>
          <avatar>0</avatar>
          <channel>CHANNEL_ID</channel>
          <commentcount>0</commentcount>
          <filetype>4</filetype>
          <hits>0</hits>
          <id>MEDIA_ID</id>
          <message>
            <p>This is some test text</p>
          </message>
          <rating>0</rating>
          <status>3</status>
          <tags>media test text example</tags>
          <title>MEDIA_TITLE</title>
          <uid>USER_ID</uid>
          <upload>2012-01-24 15:21:52</upload>
          <user_name>USER_NAME</user_name>
          <vhost>VHOST_ID</vhost>
          <votecount>0</votecount>
          <publicUrl>http://fmdevs3.filemobile.com/storage/MEDIA_ID</publicUrl>
          <thumbUrl>http://fmdev.s3.amazonaws.com/storage/MEDIA_ID</thumbUrl>
          <location>fmdevs3</location>
        </item>
      </data>
      <vhost>VHOST_ID</vhost>
    </item>
  </item>
  <item>
    <item>
      <totalCount>3</totalCount>
      <data>
        <item>
          <id>USER_ID</id>
          <firstname>USER_FIRSTNAME</firstname>
          <lastname>USER_FIRSTNAME</lastname>
          <city/>
          <country/>
          <avatar>0</avatar>
          <email>USER_EMAIL_ADDRESS</email>
          <user>USER_NAME</user>
          <gender/>
          <offset>0</offset>
        </item>
        <item>
          <id>USER_ID</id>
          <firstname/>
          <lastname/>
          <city/>
          <country/>
          <avatar>0</avatar>
          <email>USER_EMAIL_ADDRESS</email>
          <user>USER_NAME</user>
          <gender/>
          <offset>1</offset>
        </item>
      </data>
    </item>
  </item>
  <item>
    <item>GROUP_ID</item>
  </item>
</result>

Sample JSON Response

{ "status": true, "result": [ [ { "totalCount": "2", "data": [ { "avatar": "0", "channel": CHANNEL_ID, "commentcount": 0, "filetype": 1, "hits": 49, "id": MEDIA_ID, "message": "Media Example Test Upload YEYEY UPDATE", "rating": 0, "status": 3, "tags": "media example test upload", "title": "Image Example", "uid": USER_ID, "upload": "2012-01-25 16:36:47", "user_name": "USER_NAME", "vhost": VHOST_ID, "votecount": 0, "publicUrl": "http://fmdevs3.filemobile.com/storage/MEDIA_ID", "thumbUrl": "http://fmdev.s3.amazonaws.com/storage/MEDIA_ID", "location": "fmdevs3" }, { "avatar": "0", "channel": CHANNEL_ID, "commentcount": 0, "filetype": 4, "hits": 0, "id": MEDIA_ID, "message": "

\r\n\tThis is some test text media

\r\n", "rating": 0, "status": 3, "tags": "media test text example", "title": "Test text media", "uid": USER_ID, "upload": "2012-01-24 15:21:52", "user_name": "USER_NAME", "vhost": VHOST_ID, "votecount": 0, "publicUrl": "http://fmdevs3.filemobile.com/storage/MEDIA_ID", "thumbUrl": "http://fmdev.s3.amazonaws.com/storage/MEDIA_ID", "location": "fmdevs3" } ], "vhost": VHOST_ID } ], [ { "totalCount": "1", "data": [ { "firstname": "USER_FIRSTNAME", "lastname": "USER_LASTNAME", "email": "USER_EMAIL_ADDRESS", "offset": 0 }, { "firstname": "USER_FIRSTNAME", "lastname": "USER_LASTNAME", "email": "USER_EMAIL_ADDRESS", "offset": 1 } ] } ], [ "NEW_GROUP_ID" ] ] }

Code examples

PHP-RPC

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

// Listing the arguments
$arguments = array(
  'APIKEY' => 'YOURAPIKEY',
  'method' => 'system.multicall',
  'requests' => $requests
);

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

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

$data = $xmlrpc->invoke('system.multicall',$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(
  $requests
);

$data = $client->call('system.multicall',$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 = "system";
    myRemConn_rc.methodName = "multicall";
    myRemConn_rc.params = {requests:requests};
    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(requests);

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

dim apiKey as string = "YOURAPIKEY"

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

' 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 multicall ( requests ) {

var params = {
    "method" :      'system.multicall',
    "requests" :    requests}

$.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->system->multicall( $requests );

print_r($data);

0 comments

Be the first to comment on multicall.

Developer Documentation Portal