API Reference

Media.getFiles

Returns a list of media based on provided parameters.

The actual return value is a struct with the totalCount and data properties. totalCount contains the number of items that would have been returned if there was no offset or limit specified.

pageSize has a maximum value of 500 - ie. no more than 500 media items will ever be returned from a single call to this function.

If no API key is supplied, or there are insufficient permissions, this method will switch to anonymous mode. In that situation, if global moderation is set for this project it will never return unmoderated files.

Syntax

array media.getFiles ( int vhost, string sort = 'upload DESC', array filters = array(), int start = 0, int limit = 25, array fields = array(), int noCache = 0, int includeCollectionDetails = 0, int voter_uid = NULL, int includeChildMedia = 0, array childFilters = array(), array childFields = array(), string childSort = NULL, array parentFields = array(), int userId = 0, array options = array() )

Arguments

Name	Type	Required	Default value	Description
vhost	int	Required	none	The vhost id.
sort	string	Optional	'upload DESC'	Specify here which field you want to sort on.
filters	array	Optional	array()	You can specify the filter parameters here as an array. Recognized filters are listed below.
start	int	Optional	0	If you specify an offset, you will be the media items starting at this position.
limit	int	Optional	25	The total number of files you want to receive.
fields	array	Optional	array()	The list of fields you want to have returned. If fields are not supplied a set number of default fields will be returned The list of available fields are avaiable below.
noCache	int	Optional	0	By default this method caches its result for 30 seconds. Setting this parameter to 1 will always give you the latest data. This is only allowed if you have the media.getFiles permission.
includeCollectionDetails	int	Optional	0	Note: This argument has been deprecated. The data previoiusly returned when includeCollectionDetails was set to 1 (collectionInfo) is now returned by default when filters[collection] is set to a valid collection id. For more information, refer to the collectionInfo parameter in the Response Table.
voter_uid	int	Optional	NULL	Optionally, a user ID can be provided to retrieve the user vote values corresponding to the result-set, media items.
includeChildMedia	int	Optional	0	If set to 1, immediate children of the media returned in the getFiles will be included in a children p
childFilters	array	Optional	array()	You can specify the filter parameters for the child media. Valid child media filters are channel,filetype,status,moderationstatus,context and uid
childFields	array	Optional	array()	The list of fields you want returned with the child media. Default fields are 'title','message','uid','date','rating','moderationstatus''
childSort	string	Optional	NULL	Specify here which field you want to sort the child media on.
parentFields	array	Optional	array()	The list of fields you want returned with the mediai's parent. Default fields are 'title','id','uid'
userId	int	Optional	0	The ID of the user, if the user is logged in, it will be determined via the sessionToken, otherwise it will use the parameter, and not return content posted by that users block list
options	array	Optional	array()	'searchFields' An array of fields to limit searches to, valid array values are message, title,user,firstname,lastname,filename and tags

Filters

Filters allow you to restrict the data that is returned. Below is a list of valid filters.

Name	Type	Description	Default Values
filetype	INT	The filetype of the media that you wish to have returned to your. Values can be any combination of the following: 1 (image), 2 (video), 3 (audio), 4 (text).	1,2,3,4
moderationStatus	INT / STRING	The moderation status of the media that you want returned. This value can be either an integer or a media status name. For more information on moderationStatus values visit our glossary. Possible values are 0 (unmoderated), 1 (approved), 2 (denied), 3 (notdenied) or -1 (all).	notdenied
exlude_children	INT / STRING	Comma separated list of media IDs to ignore, supported in childFilters also.	None
query	STRING	A string that we will query available media for a match. We search the media filename, title, description and tags for a match with the string. Possible values would be 'teststring', or 'cats AND dogs', 'cats OR dogs', 'dogs NOT cats'.	empty
channel	INT / STRING	Specify a channel ID or a channel Short Name to have media returned from the specified channel.	empty
includeChildren	INT	Specifies weather to return media from the child channels of the specified parent channel. Possible values are 0 or 1 where 1 will return media from the specified channel and its children otherwise only media from the specified channel will be returned. This filter must be used in conjunction with the channel filter).	0
collection	INT	The collection ID that the media item will be returned from. This field must be the ID of collection in your vhost.	empty
uid	INT	Only return media uploaded by the specified user ID.	empty
title	STRING	Searches for all media files with a title that contains the specified string.	empty
favoriteuid	INT	Returns all of the favorited media by the user with the user ID that was specified. This Field is only compatible with the 'query','moderationStatus', 'channel', 'groupid' and 'includeChildGroups' filters. All other fields will be ignored. Pass -1 for the current user.	empty
parentid	INT	Return media who has a parent ID matching this integer.	empty
groupid	INT/ARRAY	Return media that is a member of the specified group ID(s)	empty
eventid	INT	Return media that is a member of the specified event ID.	empty
includeChildGroups	INT	Specifies whether or not to return media from the childgroups (groups/events) of the parent group, which is specified by the filter 'groupid' or 'eventid'. This filter is only valid when the "groupid" or "eventid" filter is set. The possible values are "true" / 1 or "false" / 0	false / 0
context	STRING	Return media which match the specified context for media type. Possible values are generic, all, comment, note, commentnote, genericcomment, parent, child. More information on context can be found in our glossary	'generic'
status	INT	The current status of uploaded media within MediaFactory. There is a status for uploading, transcoding, success, denied, error etc... The possible values are 0,1,2,3,4,100,101,102,103,104,105. To find out more information on the possible values visit the glossary	3
hidden	STRING	Only return media that has the same value of the passed hidden variable. Possible values are public, private and all. An expoination of the differences between the different hidden values can be found in our glossary	'all'
geoBoundaries	[float LAT, float LNG, float LAT, float LNG]	Return media that is located inside the bounding box made up of the latitude and longitude cooridinites. Specify as an array: [north-west lat, north-west long, south-east lat, south-east long] ([62.86,-52.44,35.08,-131.55]) to receive media within the cooridinites.	empty
geoCenter	[float LAT, float LNG]	Return media that is located inside the specified distance from this center point ([62.86,-52.44]), sorted by distance.	empty
geoDistance	INT	Distance in meters from geoCenter	empty
notuid	INT	Return media only from users other than the specified user ID	empty
parentuid	INT	Return only media whose parent's owner matches this UID will be returned. This filter is useful for showing all comments on any of a user's media when used in combination with the context filter).	empty
timeLimit	timestamp	Return media that has been uploaded after specified number of seconds. For example timeLimit=3600 will return media uploaded in the past hour (3600 seconds is one hour). Maximum time limit is 30 years (946080000 seconds).	empty
startTime	STRING	This attribute filters by the upload date. No media uploaded before the startTime will be returned. Usually you should use the 'YYYY-MM-DD HH:MM:SS' format, but using the following values will also work: 'yesterday', 'midnight', 'today', 'now', 'noon', or 'tomorrow'.	empty
endTime	STRING	This attribute filters by the upload date. No media uploaded past the endTime will be returned. Usually you should use 'YYYY-MM-DD HH:MM:SS' format, but using the following values will also work: 'yesterday', 'midnight', 'today', 'now', 'noon', or 'tomorrow'.	empty
activeTime	STRING	This attribute filters by the startdate. If only one value is provided No media with a start date before the activeTime will be returned. Otherwise you can pass a start and end time separated by , eg. 2021-01-10 10:00:00,2021-01-10 12:00,00, and this will return only media with a startdate in that range. Usually you should use the 'YYYY-MM-DD HH:MM:SS' format, but using the following values will also work: 'yesterday', 'midnight', 'today', 'now', 'noon', or 'tomorrow'.	empty
notActiveTime	STRING	This attribute filters by the end date . No media with an end date past the notActiveTime will be returned. Usually you should use 'YYYY-MM-DD HH:MM:SS' format, but using the following values will also work: 'yesterday', 'midnight', 'today', 'now', 'noon', or 'tomorrow'.	empty
externalid	STRING	Filters media based on the external ID of the media items. The possible values can be one of the following: 0 (do not filter based on external ID) exists (include only media that has an external ID set) mediaType={image\|video\|audio\|text\|unknown} Specifies to include only media of the specified type(s) that have an external ID set - media of other file types will be included regardless of their external IDs. For example: "mediaType=image,video" will return image and video media items with external IDs and text, audio and unknown media types without external IDs. and other (include only media that has the exact external ID specified)	empty
tag	STRING	Return media that contains the given tag	empty
geo	STRING	Set this to 'notnull' to return media that have valid geo-location values, meaning ones with geo_latitude <> null and geo_longitude <> null	empty

Fields

Below you will find a list and description of all of the available fields to have returned with our media.getFiles service. If you do not specify any fields the following default list will be returned to you avatar, channel, commentcount, filetype, hits, id, message, rating, status, tags, title, uid, upload, user_name, vhost, votecount, publicUrl, thumbUrl and location. If you specify atleast one filter the reponse will include id, vhost, publicUrl, thumbUrl, location and the fields sent with the request.

Name	Description
avatar	The media ID for the avatar of the user who uploaded the media.
channel	Channel ID the media belongs to.
commentcount	The number of comments made on the media item.
extension	The original file extension of the uploaded media
filetype	The file type of the piece of media (0,1,2,3,4). Further information is available in the glossary.
hits	The number of hits the piece of media has received.
message	The media message.
metadata	By specifying this to be returned as one of the fields, you will get back metadata and metadataArray. The metadata is the media metadata formatted as as a string. The metadata can be set by the user (in the media detail page) or by the developer (via the API). This value is returned as a string formatted as: {metadata: {user: {key:value,key,value}}}. For more information on media metadata, please refer to our glossary. The metadataArray allows you to read the media metadata as an array. The metadata can be set by the user (in the media detail page) or by the developer (via the API). This data is accessible with result.data[loopindex].metadataArray.user.key: for example result.data[loopindex].metadataArray.user.key: i.e. result.data[loopindex].metadataArray.user.pin and result.data[loopindex].metadataArray.user.synopisis For more information on accessing media metadata, please refer to our glossary.
moderationstatus	The moderation status represented by integers; 0 for unmoderated, 1 for approved, 2 for denied.
rating	Media rating of the media item.
rotation	The rotation of the media item signified by an int. 0 for no rotation, 1 for 90 degrees, 2 for 180 degrees, 3 for 270 degrees clockwise.
status	The media status.
hidden	Have the media hidden value returned in the response.
tags	A string of the media's tags returned to you seperated by a space. Ie: "toronto weather torontoweather".
title	The media item's title.
uid	The user ID of the user who uploaded the media.
upload	The date the media item was uploaded (YYYY-MM-DD).
lastupdatetime	The date the media item was last updated, moderated, rotated.
date	The date the media was created represented in a 24 hr clock format. (YYYY-MM-DD HH:mm:SS).
user_name	The username of the user who uplaoded the media item.
votecount	The vote count on the media item.
user_firstname	The firstname of the user who uploaded the media item.
user_lastname	The lastname of the user who uploaded the media item.
parentid	The ID of the parent media item of current media item. This is used to get the parent media ID if you are looping through a list of media comments.
parent_title	This is available only if the media has a parent media (meaning its parentid is greater than 0). This is available for all filetypes.
parent_info	This is available only if the media has a parent media (meaning its parentid is greater than 0). This is available for all filetypes.
language	2-letter ISO laguage code.
author	The name of the anonymous user (guest or public user) who uploaded the media item anonymously. All anonymous users have an ID of 1. This will be the name the user entered in the form during while commenting.
streamserver	The RTMP server for streaming if available.
streamname	The name of the stream to be requested from the streaming server if available.
context	The context of the media items.
width	The width of the media item.
height	The height of the media item.
length	The duration of the file in seconds, specified as a float with 2 decimals. This will only have a value if the media item is a video or audio file ( filetypes 2 and 3 respectivly ).
geo_latitude	The latitude of the piece of media if available.
geo_longitude	The longitude of the piece of media if avaialble.
offensive	The number of times the media was reported as offensive.
shares	The number of times the media was shared.
approvedcomments	The number of comments posted for this media that were approved.
notdeniedcomments	The number of comments posted for this media that were not denied (were approved or not yet moderated).
externalid	The external id associated with the file. Please refer to `externalid` in the Response for the structure of the returned data.
externalids	The array of external ids associated with the file. Please refer to `externalids` in the Response for the structure of the returned data.

Response

The responses returned by the getFiles service call.

Name	Description	Possible Values
avatar	The media ID for the avatar of the user who uploaded the media.	INT
channel	Channel ID the media belongs to.	INT
commentcount	The number of comments made on the media item.	INT
extension	The original file extension of the uploaded media. An example would be png.	STRING
filetype	The file type of the piece of media (0,1,2,3,4). Further information is availe in the glossary.	0,1,2,3,4
hits	The number of hits the piece of media has received.	INT
message	The media message.	STRING
metadata	This is the media metadata formatted as as a string. The metadata can be set by the user (in the media detail page) or by the developer (via the API). This value is returned as a string formatted as: {metadata: {user: {key:value,key,value}}}. For more information on media metadata, please refer to our glossary.	STRING
metadataArray	The metadataArray allows you to read the media metadata as an array. The metadata can be set by the user (in the media detail page) or by the developer (via the API). This data is accessible with result.data[loopindex].metadataArray.user.key: for example result.data[loopindex].metadataArray.user.key: i.e. result.data[loopindex].metadataArray.user.pin and result.data[loopindex].metadataArray.user.synopisis For more information on accessing media metadata, please refer to our glossary.	ARRAY Examples: result.data[index].metadataArray.user.pin result.data[index].metadataArray.user.synopsis
moderationstatus	The moderation status represented by integers; 0 for unmoderated, 1 for approved, 2 for denied.	0,1,2
rating	Media rating of the media item.	INT
rotation	The rotation of the media item signified by an int. 0 for no rotation, 1 for 90 degrees, 2 for 180 degrees, 3 for 270 degrees clockwise.	0,1,2,3
status	Media Status	INT / STRING 0, 1, 2, 3, -1, 'unmoderated', 'notdenied', 'accepted'/'approved', 'denied', 'all'
hidden	Media hidden value	STRING hidden, public, all
tags	A string of the media's tags returned to you seperated by a space. Ie: "toronto weather torontoweather".	STRING
title	The media item's title	STRING
uid	The user ID of the user who uploaded the media.	INT
upload	The date the media item was uploaded (YYYY-MM-DD).	YYYY-MM-DD
date	The date the media was created represented in a 24 hr clock format.	(YYYY-MM-DD HH:mm:SS)
user_name	The username of the user who uplaoded the media item.	INT
votecount	The vote count on the media item.	INT
uservote	This key-value pair will be omitted if voter_uid was not supplied as a parameter. The vote value on the media item with respect to the provided voter_uid user id.	NULL (no vote); 0 (negative vote); non-zero (positive vote).
user_firstname	The firstname of the user who uploaded the media item.	STRING
user_lastname	The lastname of the user who uploaded the media item.	STRING
parentid	The ID of the parent media item of current media item. This is used to get the parent media ID if you are looping through a list of media comments.	INT
parent_title	The title of the parent media.	STRING
parent_info	An array of the parent media information.	STRING
language	2-letter ISO code.	STRING
author	The name of the anonymous user (guest or public user) who uploaded the media item anonymously. All anonymous users have an ID of 1. This will be the name the user entered in the form during while commenting.	STRING
streamserver	The RTMP server for streaming if available.	STRING
streamname	The name of the stream to be requested from the streaming server if available.	STRING
context	The context of the media items.	generic, all, comment, note, commentnote, genericcomment, parent, child
width	The width of the media item.	INT
height	The height of the media item.	INT
length	The duration of the file in seconds, specified as a float with 2 decimals. This will only have a value if the media item is a video or audio file ( filetypes 2 and 3 respectivly ).	NUMBER 10.20
geo_latitude	The latitude of the piece of media if available.	NUMBER
geo_longitude	The longitude of the piece of media if avaialble.	NUMBER
collection_details	The name, search terms and query of the collection. Note: The filters[collection] argument has to be set and refer to a valid collection id in order for the collection_details field to contain data.	array ( 'name'=>'Collection 1', 'description' => 'Approved media', 'query'=> '' )
collectionDetails	The name, search terms and query of the collection. Contains the same data as 'collection_details' does. Note: The filters[collection] argument has to be set and refer to a valid collection id in order for the collectionDetails field to contain data.	array ( 'name'=>'Collection 1', 'description' => 'Approved media', 'query'=> '' )
collectionInfo	The full set of information about a collection returned when filters[collection] is set to a valid collection id. This contains more information than collection_details and collectionDetails arrays. The collectionInfo contains the following parameters: name, vhost, type, description, created, baseurl, channel, addtotop, autoactive, thumbnail, searchdata (which includes: collection, sort, sortdir timelimit, query, filetype, limit, channel, includeChildChannels, moderation, groupid, includeChildGroups, tag) terms and query of the collection. Note: The filters[collection] argument has to be set and refer to a valid collection id in order for the collectionInfo field to contain data.	array ( 'id'=>193, 'vhost'=>21, 'thumbnail'=>54321, 'type'=>2, 'name'=>'Collection 1', 'description' => 'Approved media', 'created'=>'2008-05-05 10:06:18', 'channel'=>145, 'autoactive'=>1, 'searchdata'=>array('collection'=>193, 'sort'=>'upload', 'sortdir'=>'ASC', 'timelimit'=>0, 'query'=> '', 'filetype'=>0, 'limit'=>25, 'channel'=>145, 'includeChildChannels'=>0, 'moderation'=>1, 'groupid'=>9500, 'includeChildGroups'=>1 ) )
offensive	The number of times the media was reported as offensive.	INT
shares	The number of times the media was shared.	INT
approvedcomments	The number of comments posted for this media that were approved.	INT
notdeniedcomments	The number of comments posted for this media that were not denied (were approved or not yet moderated).	INT
externalid	This is the third party ID of the file; it is available only if the file is hosted by one of our partners, such as Twitter, Instagram, Youtube, Brightcove, Widen and Ooyala. NOTE 1 The external id does not always state the external id provider. NOTE 2 It is equal to the primary media externalids reference, with the provider being stated in the reference, while in the externalids the provider is stored in the array as `external_id_provider`. Example: instagram_image:678386240811661326_1187731501	STRING Format: <externalid provider>:<externalid> Example: instagram_image:6833326_11458501
externalids	This is an array of the third party IDs for the file; it is available only if the file is hosted by one of our partners, such as Twitter, Instagram, Youtube, Brightcove, Widen and Ooyala. The external id provider values are stored as an integer, and are below: 0 - other: any provider other than the 7 mentioned below. You can store any reference using this provider. i.e. 'http://www.arbitrarysite.com/image=123' 1 - Brightcove 2 - Youtube 3 - Instagram 4 - Twitter 5 - Widen 6 - Apple 7 - Ooyala NOTE 1 Each recordset in the array is an array itself that contains the following: external_id (string) external_id_provider (integer) created (the date the externalid record created/updated) vhost primary_external_id (Integer. States whether this is the media's primary external id: possible values: 1 or 0.) . NOTE 2Only one record can be the primary external id for each media. NOTE 3The record that is noted as the primary external id is stored in the externalid with the reference to the external id provider stated before the external id.	Example array( Array ( 'external_id_provider'=>3, 'external_id'=>'6136_1186', 'created'=>'2014-03-19 17:43:11', 'vhost' => 218, 'primary_external_id' => 1 ), Array ( 'external_id_provider'=>2, 'external_id'=>'6136_1186', 'created' => '2014-03-23 07:52:54', 'vhost' => 218, 'primary_external_id' => 0 ) )

Sample Response

Sample REST Response
http://api.newspark.ca/services/rest/media/getfiles?vhost=[VHOST_ID]&filters[channel]=[CHANNEL_ID]&fields[]=avatar&fields[]=channel

<?xml version="1.0" encoding="UTF-8"?>
<result>
  <totalCount>1</totalCount>
  <data>
    <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 media</p>
</message>
      <rating>0</rating>
      <status>3</status>
      <tags>media test text example</tags>
      <title>Test text media</title>
      <uid>USER_ID</uid>
      <upload>2012-01-24 14: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>
</result>

Sample JSON Response

{ "status": true, "result": { "totalCount": 1, "data": [ { "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": 1071107, "upload": "2012-01-24 14: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 } }

Code examples

PHP-RPC

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

// Listing the arguments
$arguments = array(
  'APIKEY' => 'YOURAPIKEY',
  'method' => 'media.getFiles',
  'vhost' => '2',
  'sort' => $sort,
  'filters' => $filters,
  'start' => $start,
  'limit' => $limit,
  'fields' => $fields,
  'noCache' => $noCache,
  'includeCollectionDetails' => $includeCollectionDetails,
  'voter_uid' => $voter_uid,
  'includeChildMedia' => $includeChildMedia,
  'childFilters' => $childFilters,
  'childFields' => $childFields,
  'childSort' => $childSort,
  'parentFields' => $parentFields,
  'userId' => $userId,
  'options' => $options
);

// 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($sort),
  XML_RPC_encode($filters),
  XML_RPC_encode($start),
  XML_RPC_encode($limit),
  XML_RPC_encode($fields),
  XML_RPC_encode($noCache),
  XML_RPC_encode($includeCollectionDetails),
  XML_RPC_encode($voter_uid),
  XML_RPC_encode($includeChildMedia),
  XML_RPC_encode($childFilters),
  XML_RPC_encode($childFields),
  XML_RPC_encode($childSort),
  XML_RPC_encode($parentFields),
  XML_RPC_encode($userId),
  XML_RPC_encode($options)
);

// Creating an XML-RPC message
$message = new XML_RPC_Message('media.getFiles',$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',
  $sort,
  $filters,
  $start,
  $limit,
  $fields,
  $noCache,
  $includeCollectionDetails,
  $voter_uid,
  $includeChildMedia,
  $childFilters,
  $childFields,
  $childSort,
  $parentFields,
  $userId,
  $options
);

$data = $xmlrpc->invoke('media.getFiles',$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',
  $sort,
  $filters,
  $start,
  $limit,
  $fields,
  $noCache,
  $includeCollectionDetails,
  $voter_uid,
  $includeChildMedia,
  $childFilters,
  $childFields,
  $childSort,
  $parentFields,
  $userId,
  $options
);

$data = $client->call('media.getFiles',$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 = "media";
    myRemConn_rc.methodName = "getFiles";
    myRemConn_rc.params = {2:vhost, sort:sort, filters:filters, start:start, limit:limit, fields:fields, noCache:noCache, includeCollectionDetails:includeCollectionDetails, voter_uid:voter_uid, includeChildMedia:includeChildMedia, childFilters:childFilters, childFields:childFields, childSort:childSort, parentFields:parentFields, userId:userId, options:options};
    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, sort, filters, start, limit, fields, noCache, includeCollectionDetails, voter_uid, includeChildMedia, childFilters, childFields, childSort, parentFields, userId, options);

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

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 getFiles ( sort, filters, start, limit, fields, noCache, includeCollectionDetails, voter_uid, includeChildMedia, childFilters, childFields, childSort, parentFields, userId, options ) {

var params = {
    "method" :      'media.getFiles',
    "vhost" :       2,
    "sort" :        sort,
    "filters" :     filters,
    "start" :       start,
    "limit" :       limit,
    "fields" :      fields,
    "noCache" :     noCache,
    "includeCollectionDetails" : includeCollectionDetails,
    "voter_uid" :   voter_uid,
    "includeChildMedia" : includeChildMedia,
    "childFilters" : childFilters,
    "childFields" : childFields,
    "childSort" :   childSort,
    "parentFields" : parentFields,
    "userId" :      userId,
    "options" :     options}

$.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->media->getFiles( 2, $sort, $filters, $start, $limit, $fields, $noCache, $includeCollectionDetails, $voter_uid, $includeChildMedia, $childFilters, $childFields, $childSort, $parentFields, $userId, $options );

print_r($data);

0 comments

Be the first to comment on getFiles.

Developer Documentation Portal

API Reference

Media.getFiles

Syntax

Arguments

Filters

Fields

Response

Sample Response

Sample REST Response
http://api.newspark.ca/services/rest/media/getfiles?vhost=[VHOST_ID]&filters[channel]=[CHANNEL_ID]&fields[]=avatar&fields[]=channel

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

Media.getFiles

Syntax

Arguments

Filters

Fields

Response

Sample Response

Sample REST Responsehttp://api.newspark.ca/services/rest/media/getfiles?vhost=[VHOST_ID]&filters[channel]=[CHANNEL_ID]&fields[]=avatar&fields[]=channel

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/media/getfiles?vhost=[VHOST_ID]&filters[channel]=[CHANNEL_ID]&fields[]=avatar&fields[]=channel