Search for favorites.

22Aug2011 Posted by admin

Request URL

/user/$fav_user_id/favorites [GET]

Request Authorization

This call needs EGA authentication.

Request Parameters

Parameter (Type)	Description	Required	Default value	Max. length
fav_type (ALPHA_NUM)	Favorite link type. Value must be either "ASSET" or "COLLECTION".	Required		-
fav_user_id (ALPHA_NUM)	Search within the favorites of this supplied user ID.	Required		-
acl_domain (STRING)	Authentication parameter.	Optional		-
acl_group_id[] (ALPHA_NUM)	Authentication parameter.	Optional		-
acl_realm (STRING)	Authentication parameter.	Optional		-
acl_user_id (ALPHA_NUM)	Authentication parameter.	Optional		-
aggregatieniveau[] (STRING)	Metadata (czp) search parameter, try to use CQL instead.	Optional		-
aggregatieniveau_match (STRING)	Type matching for search parameter, try to use CQL instead. Value (when supplied) must be either "contains" or "exact" or "begin".	Optional	contains	-
app_id_search[] (INT)	Search parameter, try to use CQL instead.	Optional		-
app_id_search_match (STRING)	Type matching for search parameter, try to use CQL instead. Value (when supplied) must be either "contains" or "exact" or "begin".	Optional	contains	-
asset_id[] (STRING)	Search parameter, try to use CQL instead.	Optional		-
asset_id_match (STRING)	Type matching for search parameter, try to use CQL instead. Value (when supplied) must be either "contains" or "exact" or "begin".	Optional	contains	-
auteursrechten[] (STRING)	Metadata (czp) search parameter, try to use CQL instead.	Optional		-
auteursrechten_match (STRING)	Type matching for search parameter, try to use CQL instead. Value (when supplied) must be either "contains" or "exact" or "begin".	Optional	contains	-
batch_id (ALPHA_NUM)	Search within batch.	Optional		-
beoogde_eindgebruiker[] (STRING)	Metadata (czp) search parameter, try to use CQL instead.	Optional		-
beoogde_eindgebruiker_match (STRING)	Type matching for search parameter, try to use CQL instead. Value (when supplied) must be either "contains" or "exact" or "begin".	Optional	contains	-
beoogde_leeftijdsgroep[] (STRING)	Metadata (czp) search parameter, try to use CQL instead.	Optional		-
beoogde_leeftijdsgroep_match (STRING)	Type matching for search parameter, try to use CQL instead. Value (when supplied) must be either "contains" or "exact" or "begin".	Optional	contains	-
beschrijving[] (STRING)	Metadata (czp) search parameter, try to use CQL instead.	Optional		-
beschrijving_match (STRING)	Type matching for search parameter, try to use CQL instead. Value (when supplied) must be either "contains" or "exact" or "begin".	Optional	contains	-
calculate_total_count (BOOL)	Calculate the number of rows in the complete scope of the search and store it in the header parameter 'item_count_total'. Performance will drasticly improve with value 'FALSE' if you don't need to know the total number of assets in your scope result. If you provide 'FALSE', then 'item_count_total' value in the header will always be the number of items returned, same as 'item_count'.	Optional	TRUE	-
changed[] (DATETIME)	Search parameter, try to use CQL instead.	Optional		-
changed_match (STRING)	Type matching for search parameter, try to use CQL instead. Value (when supplied) must be either "contains" or "exact" or "begin".	Optional	contains	-
classificatie[] (STRING)	Metadata (czp) search parameter, try to use CQL instead.	Optional		-
classificatie_match (STRING)	Type matching for search parameter, try to use CQL instead. Value (when supplied) must be either "contains" or "exact" or "begin".	Optional	contains	-
coll_id[] (ALPHA_NUM)	Search within these collections.	Optional		-
context[] (STRING)	Metadata (czp) search parameter, try to use CQL instead.	Optional		-
context_match (STRING)	Type matching for search parameter, try to use CQL instead. Value (when supplied) must be either "contains" or "exact" or "begin".	Optional	contains	-
contributor[] (STRING)	Metadata (dublin_core) search parameter, try to use CQL instead.	Optional		-
contributor_match (STRING)	Type matching for search parameter, try to use CQL instead. Value (when supplied) must be either "contains" or "exact" or "begin".	Optional	contains	-
coverage_spatial[] (STRING)	Metadata (dublin_core) search parameter, try to use CQL instead.	Optional		-
coverage_spatial_match (STRING)	Type matching for search parameter, try to use CQL instead. Value (when supplied) must be either "contains" or "exact" or "begin".	Optional	contains	-
coverage_temporal[] (STRING)	Metadata (dublin_core) search parameter, try to use CQL instead.	Optional		-
coverage_temporal_match (STRING)	Type matching for search parameter, try to use CQL instead. Value (when supplied) must be either "contains" or "exact" or "begin".	Optional	contains	-
cql (STRING)	The CQL search string, used for extended and complex search options.	Optional		-
created[] (DATETIME)	Metadata (qualified_dublin_core) search parameter, try to use CQL instead.	Optional		-
created_match (STRING)	Type matching for search parameter, try to use CQL instead. Value (when supplied) must be either "contains" or "exact" or "begin".	Optional	contains	-
creator[] (STRING)	Metadata (dublin_core) search parameter, try to use CQL instead.	Optional		-
creator_match (STRING)	Type matching for search parameter, try to use CQL instead. Value (when supplied) must be either "contains" or "exact" or "begin".	Optional	contains	-
date[] (DATETIME)	Metadata (dublin_core) search parameter, try to use CQL instead.	Optional		-
date_match (STRING)	Type matching for search parameter, try to use CQL instead. Value (when supplied) must be either "contains" or "exact" or "begin".	Optional	contains	-
description[] (STRING)	Metadata (dublin_core) search parameter, try to use CQL instead.	Optional		-
description_abstract[] (STRING)	Metadata (qualified_dublin_core) search parameter, try to use CQL instead.	Optional		-
description_abstract_match (STRING)	Type matching for search parameter, try to use CQL instead. Value (when supplied) must be either "contains" or "exact" or "begin".	Optional	contains	-
description_match (STRING)	Type matching for search parameter, try to use CQL instead. Value (when supplied) must be either "contains" or "exact" or "begin".	Optional	contains	-
filename[] (STRING)	Search parameter, try to use CQL instead.	Optional		-
filename_match (STRING)	Type matching for search parameter, try to use CQL instead. Value (when supplied) must be either "contains" or "exact" or "begin".	Optional	contains	-
format[] (STRING)	Metadata (dublin_core) search parameter, try to use CQL instead.	Optional		-
format_extent[] (STRING)	Metadata (qualified_dublin_core) search parameter, try to use CQL instead.	Optional		-
format_extent_match (STRING)	Type matching for search parameter, try to use CQL instead. Value (when supplied) must be either "contains" or "exact" or "begin".	Optional	contains	-
format_match (STRING)	Type matching for search parameter, try to use CQL instead. Value (when supplied) must be either "contains" or "exact" or "begin".	Optional	contains	-
format_medium[] (STRING)	Metadata (qualified_dublin_core) search parameter, try to use CQL instead.	Optional		-
format_medium_match (STRING)	Type matching for search parameter, try to use CQL instead. Value (when supplied) must be either "contains" or "exact" or "begin".	Optional	contains	-
granted (BOOL)	Include a flag on each asset to indicate access. When providing with TRUE, the result will include assets where no access is available. The 'granted' value in the result, indicates if access was granted for the asset.	Optional	TRUE	-
group_id[] (STRING)	Search parameter, try to use CQL instead.	Optional		-
group_id_match (STRING)	Type matching for search parameter, try to use CQL instead. Value (when supplied) must be either "contains" or "exact" or "begin".	Optional	contains	-
hasformat[] (STRING)	Metadata (qualified_dublin_core) search parameter, try to use CQL instead.	Optional		-
hasformat_match (STRING)	Type matching for search parameter, try to use CQL instead. Value (when supplied) must be either "contains" or "exact" or "begin".	Optional	contains	-
hide_empty_assets (BOOL)	Do not include assets that do not have mediafiles.	Optional	FALSE	-
identificatiecode[] (STRING)	Metadata (czp) search parameter, try to use CQL instead.	Optional		-
identificatiecode_match (STRING)	Type matching for search parameter, try to use CQL instead. Value (when supplied) must be either "contains" or "exact" or "begin".	Optional	contains	-
identifier[] (STRING)	Metadata (dublin_core) search parameter, try to use CQL instead.	Optional		-
identifier_match (STRING)	Type matching for search parameter, try to use CQL instead. Value (when supplied) must be either "contains" or "exact" or "begin".	Optional	contains	-
is_public_list (BOOL)	Include or hide private assets in result. TRUE: exclude private assets, FALSE: include private assets.	Optional	FALSE	-
isformatof[] (STRING)	Metadata (qualified_dublin_core) search parameter, try to use CQL instead.	Optional		-
isformatof_match (STRING)	Type matching for search parameter, try to use CQL instead. Value (when supplied) must be either "contains" or "exact" or "begin".	Optional	contains	-
isreferencedby[] (STRING)	Metadata (qualified_dublin_core) search parameter, try to use CQL instead.	Optional		-
isreferencedby_match (STRING)	Type matching for search parameter, try to use CQL instead. Value (when supplied) must be either "contains" or "exact" or "begin".	Optional	contains	-
issued[] (DATETIME)	Metadata (qualified_dublin_core) search parameter, try to use CQL instead.	Optional		-
issued_match (STRING)	Type matching for search parameter, try to use CQL instead. Value (when supplied) must be either "contains" or "exact" or "begin".	Optional	contains	-
kosten[] (STRING)	Metadata (czp) search parameter, try to use CQL instead.	Optional		-
kosten_match (STRING)	Type matching for search parameter, try to use CQL instead. Value (when supplied) must be either "contains" or "exact" or "begin".	Optional	contains	-
language[] (STRING)	Metadata (dublin_core) search parameter, try to use CQL instead.	Optional		-
language_match (STRING)	Type matching for search parameter, try to use CQL instead. Value (when supplied) must be either "contains" or "exact" or "begin".	Optional	contains	-
license[] (STRING)	Metadata (qualified_dublin_core) search parameter, try to use CQL instead.	Optional		-
license_match (STRING)	Type matching for search parameter, try to use CQL instead. Value (when supplied) must be either "contains" or "exact" or "begin".	Optional	contains	-
limit (INT)	Limit of the items of the result set.	Optional	10	-
mediafile_container_type[] (STRING)	Search parameter, try to use CQL instead.	Optional		-
mediafile_container_type_match (STRING)	Type matching for search parameter, try to use CQL instead. Value (when supplied) must be either "contains" or "exact" or "begin".	Optional	contains	-
mediafile_duration[] (STRING)	Search parameter, try to use CQL instead.	Optional		-
mediafile_duration_match (STRING)	Type matching for search parameter, try to use CQL instead. Value (when supplied) must be either "contains" or "exact" or "begin".	Optional	contains	-
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		-
mime_type[] (STRING)	Search parameter, try to use CQL instead.	Optional		-
mime_type_match (STRING)	Type matching for search parameter, try to use CQL instead. Value (when supplied) must be either "contains" or "exact" or "begin".	Optional	contains	-
numofplays[] (INT)	Search parameter, try to use CQL instead.	Optional		-
numofplays_match (STRING)	Type matching for search parameter, try to use CQL instead. Value (when supplied) must be either "contains" or "exact" or "begin".	Optional	contains	-
numofviews[] (INT)	Search parameter, try to use CQL instead.	Optional		-
numofviews_match (STRING)	Type matching for search parameter, try to use CQL instead. Value (when supplied) must be either "contains" or "exact" or "begin".	Optional	contains	-
offset (UINT)	The starting items position in the result set.	Optional	0	-
omschrijving_rechten[] (STRING)	Metadata (czp) search parameter, try to use CQL instead.	Optional		-
omschrijving_rechten_match (STRING)	Type matching for search parameter, try to use CQL instead. Value (when supplied) must be either "contains" or "exact" or "begin".	Optional	contains	-
operator (ALPHA)	For non-CQL search only; provide either OR or AND for search parameters..	Optional	and	-
order_by (ALPHA_NUM_UNDERSCORE)	On what column the result set should be ordered.	Optional		-
order_direction (ALPHA)	The direction of the result set.	Optional	asc	-
owner_id[] (STRING)	Search parameter, try to use CQL instead.	Optional		-
owner_id_match (STRING)	Type matching for search parameter, try to use CQL instead. Value (when supplied) must be either "contains" or "exact" or "begin".	Optional	contains	-
provider_id[] (STRING)	Search parameter, try to use CQL instead.	Optional		-
provider_id_match (STRING)	Type matching for search parameter, try to use CQL instead. Value (when supplied) must be either "contains" or "exact" or "begin".	Optional	contains	-
publisher[] (STRING)	Metadata (dublin_core) search parameter, try to use CQL instead.	Optional		-
publisher_match (STRING)	Type matching for search parameter, try to use CQL instead. Value (when supplied) must be either "contains" or "exact" or "begin".	Optional	contains	-
reference_id[] (STRING)	Search parameter, try to use CQL instead.	Optional		-
reference_id_match (STRING)	Type matching for search parameter, try to use CQL instead. Value (when supplied) must be either "contains" or "exact" or "begin".	Optional	contains	-
relation[] (STRING)	Metadata (dublin_core) search parameter, try to use CQL instead.	Optional		-
relation_match (STRING)	Type matching for search parameter, try to use CQL instead. Value (when supplied) must be either "contains" or "exact" or "begin".	Optional	contains	-
return_asset_ids (BOOL)	Return only the found asset ids.	Optional	FALSE	-
rights[] (STRING)	Metadata (dublin_core) search parameter, try to use CQL instead.	Optional		-
rights_match (STRING)	Type matching for search parameter, try to use CQL instead. Value (when supplied) must be either "contains" or "exact" or "begin".	Optional	contains	-
rightsholder[] (STRING)	Metadata (qualified_dublin_core) search parameter, try to use CQL instead.	Optional		-
rightsholder_match (STRING)	Type matching for search parameter, try to use CQL instead. Value (when supplied) must be either "contains" or "exact" or "begin".	Optional	contains	-
schemanaam[] (STRING)	Metadata (czp) search parameter, try to use CQL instead.	Optional		-
schemanaam_match (STRING)	Type matching for search parameter, try to use CQL instead. Value (when supplied) must be either "contains" or "exact" or "begin".	Optional	contains	-
show_collections (BOOL)	Include collection information of each assets, when available.	Optional	FALSE	-
show_deleted (BOOL)	Include deleted assets for OAI. The deleted assets are not complete assets, these assets are empty and are only an indication that they are deleted.	Optional	FALSE	-
show_stills (BOOL)	Include stills in output.	Optional	TRUE	-
sleutelwoord[] (STRING)	Metadata (czp) search parameter, try to use CQL instead.	Optional		-
sleutelwoord_match (STRING)	Type matching for search parameter, try to use CQL instead. Value (when supplied) must be either "contains" or "exact" or "begin".	Optional	contains	-
soort_leermateriaal[] (STRING)	Metadata (czp) search parameter, try to use CQL instead.	Optional		-
soort_leermateriaal_match (STRING)	Type matching for search parameter, try to use CQL instead. Value (when supplied) must be either "contains" or "exact" or "begin".	Optional	contains	-
source[] (STRING)	Metadata (dublin_core) search parameter, try to use CQL instead.	Optional		-
source_match (STRING)	Type matching for search parameter, try to use CQL instead. Value (when supplied) must be either "contains" or "exact" or "begin".	Optional	contains	-
status[] (STRING)	Metadata (czp) search parameter, try to use CQL instead.	Optional		-
status_match (STRING)	Type matching for search parameter, try to use CQL instead. Value (when supplied) must be either "contains" or "exact" or "begin".	Optional	contains	-
subject[] (STRING)	Metadata (dublin_core) search parameter, try to use CQL instead.	Optional		-
subject_match (STRING)	Type matching for search parameter, try to use CQL instead. Value (when supplied) must be either "contains" or "exact" or "begin".	Optional	contains	-
taal[] (STRING)	Metadata (czp) search parameter, try to use CQL instead.	Optional		-
taal_match (STRING)	Type matching for search parameter, try to use CQL instead. Value (when supplied) must be either "contains" or "exact" or "begin".	Optional	contains	-
testmm30[] (STRING)	Metadata (app_1) search parameter, try to use CQL instead.	Optional		-
testmm30_match (STRING)	Type matching for search parameter, try to use CQL instead. Value (when supplied) must be either "contains" or "exact" or "begin".	Optional	contains	-
titel[] (STRING)	Metadata (czp) search parameter, try to use CQL instead.	Optional		-
titel_match (STRING)	Type matching for search parameter, try to use CQL instead. Value (when supplied) must be either "contains" or "exact" or "begin".	Optional	contains	-
title[] (STRING)	Metadata (dublin_core) search parameter, try to use CQL instead.	Optional		-
title_alternative[] (STRING)	Metadata (qualified_dublin_core) search parameter, try to use CQL instead.	Optional		-
title_alternative_match (STRING)	Type matching for search parameter, try to use CQL instead. Value (when supplied) must be either "contains" or "exact" or "begin".	Optional	contains	-
title_match (STRING)	Type matching for search parameter, try to use CQL instead. Value (when supplied) must be either "contains" or "exact" or "begin".	Optional	contains	-
type[] (STRING)	Metadata (dublin_core) search parameter, try to use CQL instead.	Optional		-
type_match (STRING)	Type matching for search parameter, try to use CQL instead. Value (when supplied) must be either "contains" or "exact" or "begin".	Optional	contains	-
user_id (ALPHA_NUM)	Alias for acl_user_id parameter, is chosen above acl_user_id.	Optional		-
versie[] (STRING)	Metadata (czp) search parameter, try to use CQL instead.	Optional		-
versie_match (STRING)	Type matching for search parameter, try to use CQL instead. Value (when supplied) must be either "contains" or "exact" or "begin".	Optional	contains	-
videotimestamp[] (DATETIME)	Search parameter, try to use CQL instead.	Optional		-
videotimestamp_match (STRING)	Type matching for search parameter, try to use CQL instead. Value (when supplied) must be either "contains" or "exact" or "begin".	Optional	contains	-
videotimestampmodified[] (DATETIME)	Search parameter, try to use CQL instead.	Optional		-
videotimestampmodified_match (STRING)	Type matching for search parameter, try to use CQL instead. Value (when supplied) must be either "contains" or "exact" or "begin".	Optional	contains	-
view_hidden_metadata (BOOL)	View hidden metadata.	Optional	FALSE	-

Example Request

user/admin/favorites?fav_type=ASSET

Example Response

<items>
  <item id="1">
    <asset_id>7pAkDsceysAZPo0q3PhjtBE1</asset_id>
    <app_id>14</app_id>
    <provider_id></provider_id>
    <owner_id>admin</owner_id>
    <group_id></group_id>
    <videotimestamp>2010-01-22 16:22:45</videotimestamp>
    <videotimestampmodified>2010-01-22 16:22:54</videotimestampmodified>
    <play_restriction_start></play_restriction_start>
    <play_restriction_end></play_restriction_end>
    <is_locked>FALSE</is_locked>
    <reference_id></reference_id>
    <isprivate>FALSE</isprivate>
    <mediafile_duration>00:00:29.92</mediafile_duration>
    <mediafile_container_type>asf</mediafile_container_type>
    <is_external>FALSE</is_external>
    <is_empty_asset>FALSE</is_empty_asset>
    <viewed>185</viewed>
    <played>105</played>
    <is_protected>FALSE</is_protected>
    <is_unappropiate>FALSE</is_unappropiate>
    <is_unappropriate>FALSE</is_unappropriate>
    <dublin_core>
      <contributor></contributor>
      <coverage_spatial></coverage_spatial>
      <coverage_temporal></coverage_temporal>
      <creator></creator>
      <date></date>
      <description></description>
      <format></format>
      <identifier></identifier>
      <language>nl</language>
      <publisher></publisher>
      <relation></relation>
      <rights></rights>
      <source></source>
      <subject></subject>
      <title>test</title>
      <type></type>
    </dublin_core>
    <qualified_dublin_core>
      <created></created>
      <description_abstract></description_abstract>
      <format_extent></format_extent>
      <format_medium></format_medium>
      <hasformat></hasformat>
      <isformatof></isformatof>
      <isreferencedby></isreferencedby>
      <issued></issued>
      <license></license>
      <rightsholder></rightsholder>
      <title_alternative></title_alternative>
    </qualified_dublin_core>
    <is_favorite>FALSE</is_favorite>
    <granted>TRUE</granted>
    <vpx_still_url>http://mediamosa2/still/F1cAk7KYiDIGYVHQKnk32YPy</vpx_still_url>
    <ega_still_url></ega_still_url>
  </item>
</items>

Search for favorites.

Request URL

Request Authorization

Request Parameters

Example Request

Example Response

MediaMosa API

Search Mediamosa 3.0

About

Developer links