HomeAboutGet the details of a collection.

Get the details of a collection.

22Aug2011 Posted by admin

A collection describes one of more assets. An asset can belong to several
collections. This call gives all the collection details.

Request URL

/collection/$coll_id [GET]

Request Authorization

This call needs EGA authentication.

Request Parameters

Parameter (Type)DescriptionRequiredDefault valueMax. length
coll_id (ALPHA_NUM)Unique collection idRequired-
hide_empty_assets (BOOL)Do not include assets that do not have mediafiles.OptionalFALSE-
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)The User ID requesting the details, used for unappropriate checks.Optional-

Example Request

/collection/A2VIXJhHiplJWliYVTVeD8Ee?user_id=foo

Example Response

<items>
  <item id="1">
    <coll_id>A2VIXJhHiplJWliYVTVeD8Ee</coll_id>
    <title>test collection</title>
    <description></description>
    <app_id>1</app_id>
    <owner_id>foo</owner_id>
    <group_id></group_id>
    <isprivate>FALSE</isprivate>
    <private>FALSE</private>
    <public>TRUE</public>
    <category>FALSE</category>
    <created>2010-03-10 11:00:59</created>
    <changed>2010-03-10 11:00:59</changed>
    <is_unappropriate>FALSE</is_unappropriate>
    <public_assign>FALSE</public_assign>
    <numofvideos>3</numofvideos>
  </item>
</items>