API Reference

Events.getEvents

Returns a list of events for a specific vhost.

Pagination may be controlled via the "startPage" and "pageSize" parameters

The optional "sort" argument is a string that can be used to specify one field to sort the returned events by.The sort parameter can also include a sort direction ("ASC" or "DESC").

All events returned will have a last resort sort applied based on the unique event ID to ensure a consistent ordering of events even when the specified sort field is not unique. Example: sort="membercount DESC" - This will return a list of events with the events with the most members first. If multiple events have the same number of members then the ones with identical member counts will be ordered by ID equivalent to sort="membercount DESC, id".

To arrange the events or events in the same order as they appear in the tree within MediaFactory you must sort by "treeleft ASC". The fields supported for sorting are: membercount, id, created ,mediacount ,approvedmediacount ,notdeniedmediacount ,name, treeleft.

The various date filters are all parsed via the equivalent of PHP's strtotime function: http://php.net/manual/en/function.strtotime.php. The preferred form is YYYY-MM-DD HH:mm:ss

Syntax

array events.getEvents ( int vhost, int uid = NULL, string moderationStatus = 'accepted', array filters = array(), string sort = 'created DESC', int|bool startPage = false, int|bool pageSize = false, bool includeTotalCount = false, bool noLimit = false, bool childGroupCount = false )

Arguments

Name	Type	Required	Default value	Description
vhost	int	Required	none	The vhost ID that the event belongs to.
uid	int	Optional	NULL	Filter by and only return events that the given user ID is a member of.
moderationStatus	string	Optional	'accepted'	Filter by moderation status (accepted, denied, unmoderated, moderated, notdenied, all).
filters	array	Optional	array()
sort	string	Optional	'created DESC'	Sets the sort field. Use format: fieldname ASC/DESC (default: "created DESC").
startPage	int\|bool	Optional	false	Starting page index for pagination (default: false, counts from 0).
pageSize	int\|bool	Optional	false	Items returned per page, max 200 (default: false, default 100).
includeTotalCount	bool	Optional	false	If true, include total matching event count in response.
noLimit	bool	Optional	false	If true, disable pagination (requires events.getEventsNoLimit permission).
childGroupCount	bool	Optional	false	If true, include child event count for parentGroupId.

Optional Filters

The optional "filters" parameter is an array that may contain filter options.

Name	Type	Description	Default	Possible Values
creatorUserID	INT	Returns only events created by the specified user ID.	empty	INT
parentEventID	INT	Returns only events whose parent is the event specified.	INT	INT
includeChildren	BOOL	Returns all events who have parentEventID as their ancestor.	true	false
searchQuery	STRING	A string that must exist in name, description, address, host, or city.	empty	STRING
searchName	STRING	A string that must exist in the name of the events returned.	empty	STRING
searchDescription	STRING	A string that must exist in the description of events.	empty	STRING
custom1	STRING	A string that must match the custom1 field value.	empty	STRING
mediaID	INT	A media item that must be present within the events.	empty	INT
endBefore	YYYY-MM-DD HH:MM:SS	A date and time that events must end before.	empty	YYYY-MM-DD HH:MM:SS
endAfter	YYYY-MM-DD HH:MM:SS	A date and time that events must end after.	empty	YYYY-MM-DD HH:MM:SS

Response

The response items returned in a events.getEvents service call.

Name	Type	Description	Possible Values
id	INT	The ID of the event.	INT
name	STRING	The name of the event.	STRING
description	STRING	A brief blurb about the event.	STRING
note	STRING	Some text about the event (not searchable).	STRING
logo	INT	The media ID that is used as the event logo.	INT
url	STRING	The url of the event.	STRING
created	YYYY-MM-DD HH:MM:SS	The date the event was created.	YYYY-MM-DD HH:mm:SS
createdBy	INT	The user ID of the user who created the event.	INT
memberCount	INT	The number of members in the event.	INT
mediaCount	INT	The number of media items in the event.	INT
approvedMediaCount	INT	The number of approved media items.	INT
notDeniedMediaCount	INT	The number of not denied media items.	INT
geo_longitude	LNG	The longitude of the event.	NUMBER (-52.44)
geo_latitude	LAT	The latitude of the event.	NUMBER (62.86)
moderationStatus	STRING	The moderation status of the event.	accepted, denied, unmoderated, moderated, notdenied, all
parentEvent	INT	The ID of the parent event.	INT
address	STRING	The address of the event.	STRING
city	STRING	The city that the event is located in.	STRING
country	STRING	The country (2-letter code).	STRING
state	STRING	The state/province (2-letter code).	STRING
postalcode	STRING	A valid postal code.	STRING
newMediaEmailTemplateID	INT	ID of email template for new media notifications.	INT
host	STRING	The name of the host who created the event.	STRING
groupType	INT	1 for group, 2 for event.	1/2
vhost	INT	The vhost ID that the event belongs to.	INT
other	ARRAY	Additional information (not searchable).	ARRAY
custom1	STRING	A searchable and filterable custom field.	STRING
treeleft	INT	Used internally for sorting and ordering events.	INT
treeright	INT	Used internally for sorting and ordering events.	INT
email	STRING	Email address for uploading media to the event.	STRING
totalCount	INT	Total count if includeTotalCount is true.	INT
startDate	YYYY-MM-DD HH:MM:SS	The start date of the event.	YYYY-MM-DD HH:MM:SS
endDate	YYYY-MM-DD HH:MM:SS	The end date of the event.	YYYY-MM-DD HH:MM:SS

Sample Response

Sample REST Response
http://api.newspark.ca/services/rest/events/getEvents?eventId=[EVENT_ID]&includeTotalCount=true&filters[includeChildren]=true&filters[parentEventID]=[PARENT_EVENT_ID]&APIKEY=[APIKEY]

<?xml version="1.0" encoding="UTF-8"?>
<result>
  <item>
    <id>EVENT_ID</id>
    <name>EVENT_NAME</name>
    <description/>
    <note/>
    <logo>0</logo>
    <publicUrl/>
    <thumbUrl/>
    <url/>
    <created>2012-02-13 11:15:44</created>
    <createdBy>1</createdBy>
    <memberCount>0</memberCount>
    <mediaCount>0</mediaCount>
    <approvedMediaCount>0</approvedMediaCount>
    <notDeniedMediaCount>0</notDeniedMediaCount>
    <geo_longitude>0</geo_longitude>
    <geo_latitude>0</geo_latitude>
    <moderationStatus>unmoderated</moderationStatus>
    <parentGroup>0</parentGroup>
    <address/>
    <city/>
    <country/>
    <state/>
    <postalcode/>
    <newMediaEmailTemplateID>0</newMediaEmailTemplateID>
    <host/>
    <groupType>2</groupType>
    <vhost>VHOST</vhost>
    <other/>
    <custom1/>
    <treeleft>65</treeleft>
    <treeright>66</treeright>
    <email>EVENT_CREATORS_EMAIL</email>
    <startDate/>
    <endDate/>
  </item>
  <item>
    <id>EVENT_ID</id>
    <name>EVENT_NAME</name>
    <description/>
    <note/>
    <logo>0</logo>
    <publicUrl/>
    <thumbUrl/>
    <url/>
    <created>2012-01-28 19:33:59</created>
    <createdBy>1</createdBy>
    <memberCount>0</memberCount>
    <mediaCount>1</mediaCount>
    <approvedMediaCount>0</approvedMediaCount>
    <notDeniedMediaCount>0</notDeniedMediaCount>
    <geo_longitude>0</geo_longitude>
    <geo_latitude>0</geo_latitude>
    <moderationStatus>accepted</moderationStatus>
    <parentGroup>0</parentGroup>
    <address/>
    <city/>
    <country/>
    <state/>
    <postalcode/>
    <newMediaEmailTemplateID>0</newMediaEmailTemplateID>
    <host/>
    <groupType>2</groupType>
    <vhost>VHOST_ID</vhost>
    <other/>
    <custom1/>
    <treeleft>59</treeleft>
    <treeright>60</treeright>
    <email>EVENT_CREATORS_EMAIL</email>
    <startDate/>
    <endDate/>
  </item>
  <totalCount>2</totalCount>
</result>

Sample JSON Response

{
    "status": true,
    "result": {
        "0": {
            "id": "EVENT_ID",
            "name": "EVENT_NAME",
            "description": "",
            "note": "",
            "logo": "0",
            "publicUrl": "",
            "thumbUrl": "",
            "url": "",
            "created": "2012-02-13 11:15:44",
            "createdBy": "1",
            "memberCount": "0",
            "mediaCount": "0",
            "approvedMediaCount": "0",
            "notDeniedMediaCount": "0",
            "geo_longitude": "0",
            "geo_latitude": "0",
            "moderationStatus": "unmoderated",
            "parentGroup": "0",
            "address": "",
            "city": "",
            "country": "",
            "state": "",
            "postalcode": "",
            "newMediaEmailTemplateID": "0",
            "host": "",
            "groupType": "2",
            "vhost": "VHOST_ID",
            "other": [],
            "custom1": "",
            "treeleft": "65",
            "treeright": "66",
            "email": "EVENT_CREATORS_EMAIL",
            "startDate": null,
            "endDate": null
        },
        "1": {
            "id": "EVENT_ID",
            "name": "EVENT_NAME",
            "description": "",
            "note": "",
            "logo": "0",
            "publicUrl": "",
            "thumbUrl": "",
            "url": "",
            "created": "2012-01-28 19:33:59",
            "createdBy": "1",
            "memberCount": "0",
            "mediaCount": "1",
            "approvedMediaCount": "0",
            "notDeniedMediaCount": "0",
            "geo_longitude": "0",
            "geo_latitude": "0",
            "moderationStatus": "accepted",
            "parentGroup": "0",
            "address": "",
            "city": "",
            "country": "",
            "state": "",
            "postalcode": "",
            "newMediaEmailTemplateID": "0",
            "host": "",
            "groupType": "2",
            "vhost": "VHOST_ID",
            "other": [],
            "custom1": "",
            "treeleft": "59",
            "treeright": "60",
            "email": "EVENT_CREATORS_EMAIL",
            "startDate": null,
            "endDate": null
        },
        "totalCount": "2"
    }
}

Code examples

PHP-RPC

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

// Listing the arguments
$arguments = array(
  'APIKEY' => 'YOURAPIKEY',
  'method' => 'events.getEvents',
  'vhost' => '2',
  'uid' => $uid,
  'moderationStatus' => $moderationStatus,
  'filters' => $filters,
  'sort' => $sort,
  'startPage' => $startPage,
  'pageSize' => $pageSize,
  'includeTotalCount' => $includeTotalCount,
  'noLimit' => $noLimit,
  'childGroupCount' => $childGroupCount
);

// 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($uid),
  XML_RPC_encode($moderationStatus),
  XML_RPC_encode($filters),
  XML_RPC_encode($sort),
  XML_RPC_encode($startPage),
  XML_RPC_encode($pageSize),
  XML_RPC_encode($includeTotalCount),
  XML_RPC_encode($noLimit),
  XML_RPC_encode($childGroupCount)
);

// Creating an XML-RPC message
$message = new XML_RPC_Message('events.getEvents',$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',
  $uid,
  $moderationStatus,
  $filters,
  $sort,
  $startPage,
  $pageSize,
  $includeTotalCount,
  $noLimit,
  $childGroupCount
);

$data = $xmlrpc->invoke('events.getEvents',$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',
  $uid,
  $moderationStatus,
  $filters,
  $sort,
  $startPage,
  $pageSize,
  $includeTotalCount,
  $noLimit,
  $childGroupCount
);

$data = $client->call('events.getEvents',$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 = "events";
    myRemConn_rc.methodName = "getEvents";
    myRemConn_rc.params = {2:vhost, uid:uid, moderationStatus:moderationStatus, filters:filters, sort:sort, startPage:startPage, pageSize:pageSize, includeTotalCount:includeTotalCount, noLimit:noLimit, childGroupCount:childGroupCount};
    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, uid, moderationStatus, filters, sort, startPage, pageSize, includeTotalCount, noLimit, childGroupCount);

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

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 getEvents ( uid, moderationStatus, filters, sort, startPage, pageSize, includeTotalCount, noLimit, childGroupCount ) {

var params = {
    "method" :      'events.getEvents',
    "vhost" :       2,
    "uid" :         uid,
    "moderationStatus" : moderationStatus,
    "filters" :     filters,
    "sort" :        sort,
    "startPage" :   startPage,
    "pageSize" :    pageSize,
    "includeTotalCount" : includeTotalCount,
    "noLimit" :     noLimit,
    "childGroupCount" : childGroupCount}

$.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->events->getEvents( 2, $uid, $moderationStatus, $filters, $sort, $startPage, $pageSize, $includeTotalCount, $noLimit, $childGroupCount );

print_r($data);

0 comments

Be the first to comment on getEvents.

Developer Documentation Portal

API Reference

Events.getEvents

Syntax

Arguments

Optional Filters

Response

Sample Response

Sample REST Response
http://api.newspark.ca/services/rest/events/getEvents?eventId=[EVENT_ID]&includeTotalCount=true&filters[includeChildren]=true&filters[parentEventID]=[PARENT_EVENT_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

Events.getEvents

Syntax

Arguments

Optional Filters

Response

Sample Response

Sample REST Responsehttp://api.newspark.ca/services/rest/events/getEvents?eventId=[EVENT_ID]&includeTotalCount=true&filters[includeChildren]=true&filters[parentEventID]=[PARENT_EVENT_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/events/getEvents?eventId=[EVENT_ID]&includeTotalCount=true&filters[includeChildren]=true&filters[parentEventID]=[PARENT_EVENT_ID]&APIKEY=[APIKEY]