Parameter

Type

Description

Method

Obligatory/Optional

asset_id

alphanumeric

the asset where the information has to collect

URL

obligatory

limit

numeric

maximum number of reponse items

GET

obligatory

offset

numeric

gives <limit> items back from <offset>

GET

optional

order_by

string

Sorting the list with this field

e.g.: order_by=changed

Other possible fields:

title, description, owner_id, group_id, created, changed, private, public, category, numofvideos

GET

optional

order_direction

string

Sorint in ascending ('asc') or descending ('desc') order.

Example: order_direction=desc

GET

optional

created, changed

ISO 8601 datum/time period

This makes it possible within a time period to search. The format for datetime is YYYY-MM-DD HH: MM: SS. Where only the year is required. If you want to see results from 2006-2008, were you created assets, you can use:
videotimestamp=2006|2009
The | sign separate the date 2 times. The 2nd datetime is considered "till". In the example, so only results from 2006, 2007 and 2008 returned.

videotimestamp=2007-04-01 00:00:00|2007-05

This example shows all results of April in 2007. The same result is reached with
videotimestamp=2007-04|2007-05

GET

optional

title, description, owner_id, group_id

string

All of these fields can be in the search.

Example:

owner_id=test&group_id=test2

owner_id[]=test&owner_id[]=t2

GET

optional

<veldnaam>_match

string

By default, all search matches "contains", but these can be adjusted using <fieldname> _match = <type>

Possible values: 'exact', 'contains' and 'begin'

Example: title=test&title_match=exact

GET

optional

private, category, public

boolean

Search the boolean (true / false) fields.

Example:

public=true (gives back all of the collections that public is true)

GET

optional

Field

Description

item

Full description of the collection in XML format