HomeAboutcollection/$coll_id

collection/$coll_id

28Sep2009 Posted by forgacs

Customizing collection information

With this call you can adjust the collection parameters.

Request URL

/collection/{coll_id} [POST]

Request parameters

Parameter

Type

Description

Method

Obligatory/Optional

coll_id

alphanumeric

the asset where the information should be updated

URL

obligatory

user_id

string

this user id is for the authorisation.

POST

obligatory

title

string

Titel of the collection

POST

optional

description

string

Description of the collection

POST

optional

private

'true' / 'false'

is it 'private' collection

POST

optional

public

'true' / 'false'

is it 'public' collection

POST

optional

category

'true' / 'false'

is it 'category' collection

POST

optional

isprivate

'true' / 'false'

 

POST

optional

public_assign

'true' / 'false'

A 'true' value indicates that all users have access to the collection

POST

optional

owner_id

string

the possible new owner of the asset

POST

optional

group_id

string

the possible new group of the asset.

POST

optional

is_app_admin

boolean

Indicates whether the rest call is called by admin. This flag ensures that the admin the only one, who can change 'is_unappropiate' and / or "owner_id" and / or 'group_id' fields.

POST

optional; default = false

is_unappropriate

true/false

If is_unappropiate = true then only the owner or the app admin can see this collection. Only the app manager can change this flag.

POST

optional

 

Example request URL

/collection/VlN2ZDKv9rpsfmBAWpvfiw1zQ6z
POST:

title=”Titel of the collection”

description=”Description of the collection”

Response fields

Field

Description

n/a

This call doesn't return others, just the standard header with the request information