Skip to end of metadata
Go to start of metadata

Collection API

Get a list of Collections

This method will return all collections within a collection "folder". To iterate for sub-collections you will need to call this method each time.

Method

Method Name

Returns

getcollections

Record set

Input Parameter

Parameter

Description

Type

Required

Sample Input

 

api_key

A valid api key

String

yes

54592180-7060-4D4B-BC74-2566F4B2F943

 

folderid

The ID of the collection folder you want to retrieve collections from.

String

yes

2
As of Razuna 1.5.5 you can also pass in a list of folderid's like:
1,34,234

Razuna 1.5.5
Hosted Edition since 16.12.2012
releasedQuery collections according to released statusStringnoEmpty value (default)
true
false
Razuna 1.5.5
Hosted Edition since 10.03.2012 

Output Value

Name

Description

Sample Output

 

col_id

ID of the collection

212

 

change_date

Date of the last change to this collection

 

 
col_nameName of collectionMy collection 
collection_descriptionDescriptionMy collection descriptionRazuna 1.5.5 (hosted edition 12.11.2012)
collection_keywordsKeywordsMy keywordsRazuna 1.5.5 (hosted edition 16.12.2012)
col_releasedStatus of releasetrueRazuna 1.5.5 (hosted edition 10.03.2012)
col_copied_fromIf copied parent collection ID108Razuna 1.5.5 (hosted edition 10.03.2012)

totalassets

How many assets are in this collection

8

 

totalimg

How many images are in this collection

5

 

totalvid

How many videos are in this collection

2

 

totaldoc

How many documents are in this collection

1

 

totalaud

How many audios are in this collection

3

 

REST: Sample Request

Sample Output

Output format

Remember you can adjust the output dynamically. The API returns JSON by default. For record sets it defaults to a ROW based set, if you need COLUMNS simply append "&__BDQUERYFORMAT=column" to your call. In case, you need JSONP you want to append "&__BDRETURNFORMAT=jsonp&callback=?". In order to retrieve XML (WDDX) you simply need to append "&__BDRETURNFORMAT=wddx".

Retrieving all assets in a collection

Method

Method Name

Returns

getassets

Record set

Input Parameter

Parameter

Description

Type

Required

Sample Input

api_key

A valid api_key

String

yes

54592180-7060-4D4B-BC74-2566F4B2F943

collectionid

The ID of the collection you want to retrieve assets from.

String

yes

1

Output Value

Name

Description

Sample Output

Response

A result code with the status of the login. If the result is 0 the method was successful.

0

calledwith

The collection id you called this method

1

totalassetscount

How many assets are in this folder

8

different value fields

Each record with is lists

see sample output

Updates

As of Razuna 1.5.5 (hosted edition since 30.01.2013) the additional column "rendition_id" and "rendition_url" are being returned, also.

REST: Sample Request

Sample Output

Output format

Remember you can adjust the output dynamically. The API returns JSON by default. For record sets it defaults to a ROW based set, if you need COLUMNS simply append "&__BDQUERYFORMAT=column" to your call. In case, you need JSONP you want to append "&__BDRETURNFORMAT=jsonp&callback=?". In order to retrieve XML (WDDX) you simply need to append "&__BDRETURNFORMAT=wddx".

Availability

Search for collections is available as of Razuna 1.5.5 and on the Hosted Edition as of 16.12.2012!
As of Razuna 1.5.5 (hosted edition since 16.12.2012) the column "colid" holds the collection ID(s) the file might be in.

Method

Method Name

Returns

search

Record set

Input Parameter

Parameter

Description

Type

Required

Sample Input

api_key

A valid api_key

String

yes

54592180-7060-4D4B-BC74-2566F4B2F943

id

ID of a collection

String

no

1

nameNameStringnomy collection
descriptionDescriptionStringnomy description
keywordKeywordStringnomy keyword
released Stringnotrue
false

(Name, description and keywords searches will be made as "wildcard" searches. Technically, a SQL LIKE and adding "%")

Output Value

The search will return the exact output as the getcollection() method!

REST: Sample Request

Output format

Remember you can adjust the output dynamically. The API returns JSON by default. For record sets it defaults to a ROW based set, if you need COLUMNS simply append "&__BDQUERYFORMAT=column" to your call. In case, you need JSONP you want to append "&__BDRETURNFORMAT=jsonp&callback=?". In order to retrieve XML (WDDX) you simply need to append "&__BDRETURNFORMAT=wddx".

  • No labels