HomeAboutUpdate a collection.

Update a collection.

22Aug2011 Posted by admin

Update the fields of a collection.

Request URL

/collection/$coll_id [POST]

Request Authorization

This call needs EGA authentication.

Request Parameters

Parameter (Type)DescriptionRequiredDefault valueMax. length
coll_id (ALPHA_NUM)The collection ID.Required-
user_id (ALPHA_NUM)The user ID, must match the owner of the collection, otherwise the update will fail.Required-
category (BOOL)Used to identify main category collections, use [GET] /collection?category=true to get these collections.Optional-
description (STRING)Description of the collection.Optional-
group_id (ALPHA_NUM)The group ID.Optional-
is_app_admin (BOOL)A boolean to indicate the call is done by the APP admin. It overrides user autorisation.Optionalfalse-
is_unappropriate (BOOL)A field to flag the collection as inappropriate. Only the is_app_admin is allowed to set this parameter. When set, the collection will not be shown except to the user and the is_app_admin. It does not affect assets belonging to the collection.Optional-
isprivate (BOOL)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-
owner_id (ALPHA_NUM)An user who is the current owner can reassign a new owner; after changing the owner, the old owner has no rights to modify the collection.Optional-
private (BOOL)Used to identify private collections, use [GET] /collection?private=true to get these collections.Optional-
public (BOOL)Used to identify public collections, use [GET] /collection?public=true to get these collections.Optional-
public_assign (BOOL)Optional-
title (STRING)The title of the collection.Optional-

Example Request

/collection/b1Tb9eoIgOeSLZ9cGO04rPej [POST] user_id=foo&title=bar&description=baz

Example Response

<request_result>success</request_result>
<request_result_description></request_result_description>
<request_result_id>601</request_result_id>