OpenSocial: MediaItem GET

[MC-arjen]

We will start with a basic OpenSocial? support;

Link:  http://opensocial-resources.googlecode.com/svn/spec/1.1/Social-API-Server.xml#MediaItems-Service

URI: /mediaItems/$User-Id/$Group-Id/$Album-Id[/$MediaItem-Id] [GET]

A request to retrieve MediaItems? must support the Standard-Request-Parameters and the Collection-Request-Parameters:  http://opensocial-resources.googlecode.com/svn/spec/1.1/Core-API-Server.xml#Standard-Request-Parameters

• Request-Parameter-UpdatedSince?-Value = When specified the container should only return items whose updated date & time is equal to or more recent then the specified value. The value MUST be a valid [XSdateTime] (e.g. 2008-01-23T04:56:22Z).
• Request-Parameter-Formet-Value = Specifies the desired return encoding of the request. Must be one of "json", "xml", or "atom".
• Request-Parameter-Count-Value = The page size for a paged collection. If no parameter is specified the container can choose how many items in the collection should be returned. However, the container should support a large default count value so that all items can be returned by default.
• Request-Parameter-FilterBy?-Value = For a collection, return entries filtered by the given field name.
• Request-Parameter-FilterOp?-Value = "contains" / "equals" / "startsWith" / "present". The operation to use when filtering a collection by a field specified in 'filterBy', defaults to "contains".
• Request-Parameter-FilterValue?-Value = The value to use when filtering a collection.
• Request-Parameter-SortOrder?-Value = "ascending" / "descending"
• Request-Parameter-StartIndex?-Value = Index into a paged collection.

And the following additional parameters:

• Name - Type - Description
• userId - User-Id or Array<User-Id> - User ID(s) of the person whose MediaItems? are to be returned. Defaults to "@me", indicating the currently authenticated user. In the REST protocol, userId is specified in the REST-URI-Fragment, rather than in the REST-Query-Parameters.
• groupId - Group-Id - The group ID of the group of users whose MediaItems? are to be returned. Defaults to "@self", which MUST return only the MediaItems? specified by the userId parameter. In the REST protocol, the groupId is specified in the REST-URI-Fragment, rather than in the REST-Query-Parameters.
• albumId - Object-Id - The ID of the album whose MediaItems? are to be returned. If no albumId is provided, then the container should return media items from all albums. In the REST protocol, the albumId is specified in the REST-URI-Fragment, rather than in the REST-Query-Parameters.
• appId - App-Id - Optional. Specifies that the response should only contain MediaItems? generated by the given appId. If not included, the container must return MediaItems? created by the currently authenticated app. In the REST protocol, the appId is not used, indicating the container must return MediaItems? created by the currently authenticated app.
• id - Array<Object-Id> - A list of MediaItem? IDs specifying the MediaItems? to retrieve.

[Frans]

Fixed in 2.4

[forgacs]

Documentation about the OpenAPI interface: #434
Direct link:
 http://opensocial-resources.googlecode.com/svn/spec/1.1/Social-API-Server.xml#MediaItems-Service

Example:
/openapi/mediaItems/@me/@self/eeXiZLRUWj9aMZGd3fndFWik/A1NfJfZQPPSvJOWUChVgwm1c
Where:
@me = the current user
@self = the group the user belongs to
eeXiZLRUWj9aMZGd3fndFWik = album_id (asset_id)
A1NfJfZQPPSvJOWUChVgwm1c = mediaitem_id (mediafile_id)

Example2:
/openapi/mediaItems/admin/@self/eeXiZLRUWj9aMZGd3fndFWik/A1NfJfZQPPSvJOWUChVgwm1c

Example3:
/openapi/mediaItems/admin/@self