HomeAboutOpenSocial get media items.

OpenSocial get media items.

22Aug2011 Posted by admin

The MediaItems Service support requests to retrieve mediafiles.

Request URL

/openapi/mediaItems/$items_user_id/$group_id/$album_id/$mediaitem_id [GET]

Request Authorization

This call needs EGA authentication.

Request Parameters

Parameter (Type)DescriptionRequiredDefault valueMax. length
items_user_id (ALPHA_NUM)The person whose MediaItems are to be returned. Defaults to "@me", indicating the currently authenticated user.Required@me-
Request-Parameter-Count-Value (INT)The page size for a paged collection.Optional10-
Request-Parameter-FilterBy-Value (ALPHA)For a collection, return entries filtered by the given field name.Optional-
Request-Parameter-FilterOp-Value (STRING)The operation to use when filtering a collection by a field specified in "filterBy", defaults to "contains".
Value (when supplied) must be either "contains" or "equals" or "startsWith" or "present".		Optionalcontains-
Request-Parameter-FilterValue-Value (STRING)The value to use when filtering a collection.Optional-
Request-Parameter-Format-Value (RESPONSE_TYPE)Optional parameter to specify the response output format.
Value (when supplied) must be either "xml" or "atom" or "rss" or "json".		Optional-
Request-Parameter-Formet-Value (RESPONSE_TYPE)Optional parameter to specify the response output format.
Value (when supplied) must be either "xml" or "atom" or "rss" or "json".		Optional-
Request-Parameter-SortOrder-Value (STRING)Can either be "ascending" or "descending", defaults to ascending. Used to sort objects in a collection.
Value (when supplied) must be either "ascending" or "descending".		Optionalascending-
Request-Parameter-StartIndex-Value (UINT)Index into a paged collection.Optional0-
Request-Parameter-UpdatedSince-Value (DATETIME_UTC)Only return items whose updated date & time is equal to or more recent then the specified value (e.g. 2008-01-23T04:56:22Z).Optional-
album_id (ALPHA_NUM)The ID of the album whose MediaItems are to be returned. Optional-
app_id[] (APP_ID)The application ID.Optional0-
appid (APP_ID)Specifies that the response should only contain MediaItems generated by the given appId.Optional-
group_id (ALPHA_NUM)The group ID of the group of users whose MediaItems are to be returned. Defaults to "@self".Optional@self-
mediaitem_id (ALPHA_NUM)MediaItem ID specifying the MediaItems to retrieve.Optional-
mediamosa_version (MEDIAMOSA_VERSION)Provide the version to get the REST call returned in the format of the specified MediaMosa version. Keep empty or skip to retrieve in current (latest) version. Provide '2' to retrieve the REST call in 2.x format. Or be more specific by providing up to 3 digits; '2.3.0'. This setting will override any setting used by client application or the default setting in MediaMosa.Optional-
user_id (ALPHA_NUM)User id.Optional-

Example Request

openapi/mediaItems/owner/group

Example Response

<?xml version="1.0" encoding="utf-8"?>
<feed xmlns="http://www.w3.org/2005/Atom">
  <title>MediaMosa Atom Feed</title>
  <link href="http://mediamosa.org/"/>
  <updated>2010-12-13T18:30:02Z</updated>
  <author>
    <name>MediaMosa</name>
  </author>
  <id>MediaMosa:feed:atom:search</id>
  <entry>
    <title>Morning news</title>
    <link href="http://yourise.org/2003/12/13/news"/>
    <id>asset_id:Q2DQJjCMIfPejfnkM8mjekw6</id>
    <updated>2010-10-13T18:03:25Z</updated>
    <summary>Chrismas in Amsterdam.</summary>
  </entry>
</feed>