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 startPage = false, int 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 the event list by the specified moderation status. The possible values are "accepted", "denied", "unmoderated", "moderated", "notdenied","all".
filters	array	Optional	array()	See the list of possible filters for events.getEvents service below.
sort	string	Optional	'created DESC'	Sets the sort field. Use the format fieldname ASC/DESC. Currently created, membercount, mediacount, id, approvedmediacount, notdeniedmediacount, name, startdate, enddate, and treeleft are supported. To retrieve the events in the same order they are in the event tree use "treeleft ASC".
startPage	int	Optional	false	Sets the startpage for the event list. This is used with pagination in conjunction with pageSize. The starting page index is 0 (the first page).
pageSize	int	Optional	false	Sets the total number of items returned per page. This is used with pagination and in conjunction with startPage. The maximum number of events to include on each page by default is 100 and the maximum is 200.
includeTotalCount	bool	Optional	false	If "includeTotalCount" is "true" then the total number of matching events will be returned along with the events themselves. If it's "false" then the total count will not be returned. The default for includeTotalCount is false.
noLimit	bool	Optional	false	You may disable all pagination and limits on the number of events returned by setting the "noLimit" parameter to "true". This requires the events.getEventsNoLimit permission.
childGroupCount	bool	Optional	false	If "childGroupCount" is "true" then the total number of child events for the parengGroupId will be returned. If it's "false" then the total count will not be returned. The default for childGroupCount is false.

Optional Filters

The optional "filters" parameter is an array that may contain the following keys and values.

Name	Type	Description	Default	Possible Values
creatorUserID	INT	Returns only events created by the specified user ID. If the user ID specified is not the user that is currently logged in and is not the public user then a check is made for the "events.getEvents" permission.	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. May only be used in combination with the parentEventID filter.	true	false
searchQuery	STRING	A string that must exist in at least one of the following fields.	empty	name, description, address, host, city
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 the events returned.	empty	STRING
custom1	STRING	A string that must match the value of the custom1 field of the events returned.	empty	STRING
mediaID	INT	A media item that must be present within the events returned.	empty	INT
endBefore	YYYY-MM-DD HH:MM:SS	A date and time that the listed events must end before.	empty	YYYY-MM-DD HH:MM:SS
endAfter	YYYY-MM-DD HH:MM:SS	A date and time that the listed 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. History, purpose, location, ideas, awards, etc. The description is searchable.	STRING
note	STRING	Some text about the event. The note is not searchable.	STRING
logo	INT	The media ID that is used as the event logo.	INT
publicUrl	STRING	The url to access the event logo. The public url will log a hit against the media item when ever loaded. This would be best used on an event details page.	STRING
thumbUrl	STRING	The url to access the event logo. The thumb url will _NOT_ log a hit against the media item when loaded. This is best used in event galleries or plotting events on a map.	STRING
url	STRING	The url of the event. This is used best if the event is for a company, an event with a unique url they wish to also direct traffic to.	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 in the event.	INT
notDeniedMediaCount	INT	The number of not denied media items in the event.	INT
geo_longitude	LNG	The longitude of the event. This would be specified by the creator of the event.	NUMBER (-52.44)
geo_latitude	LAT	The latitude of the event. This would be specified by the creator of the event.	NUMBER (62.86)
moderationStatus	STRING	The moderation status of the event which has just been created. By default if this is not passed the events moderationstatus will be unmoderated.	accepted, denied, unmoderated, moderated, notdenied, all
parentEvent	INT	The ID of the parent event if the current event is a child.	INT
address	STRING	The address of the event.	STRING
city	STRING	The city that the event is located in.	INT
country	STRING	The country that the event is located in. This will be a 2-letter country code.	STRING
state	STRING	This will be the state/province that the event is located in. It will be a 2-letter state/province code.	STRING
postalcode	STRING	A valid postal code to contact the event by.	STRING
newMediaEmailTemplateID	INT	This is the ID of the email template that is sent out when a user uploads media into the event.	INT
host	STRING	The name of the host who created the event or who is inchagre of the event.	STRING
groupType	INT	This specifies if the group is a group or an event. 1 represents a group and 2 represents an event.	1/2
vhost	INT	The vhost ID that the event belongs to.	INT
other	ARRAY	An associated array that is used to store any additional information about the event that does not fit in any previous fields. This field is _NOT_ searchable or filterable. This is equivelent to the metadata field for media.	ARRAY
custom1	STRING	A searchable and filterable field for any additional information that does not fit into any previous field.	STRING
treeleft	INT	Used internally for the sorting and ordering events.	INT
treeright	INT	Used internally for the sorting and ordering events.	INT
email	STRING	The email address to use to allow users to email content to this email address and have it uploaded and entered into the event.	STRING
totalCount	INT	If the includeTotalCount argument is set to true the total count of events returned will be included in the response.	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.filemobile.com/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.filemobile.com/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.filemobile.com/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.filemobile.com/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.filemobile.com/services/rest/events/getEvents?eventId=[EVENT_ID]&includeTotalCount=true&filters[includeChildren]=true&filters[parentEventID]=[PARENT_EVENT_ID]&APIKEY=[APIKEY]