collections.getCollections

Syntax

bool collections.getCollections ( int vhost, int type = 0, mixed includeCount = false )

Argument Info

NameTypeRequiredDefault valueDescription
vhostintRequirednoneThe ID of the vhost the collection belongs to.
typeintOptional0The type of collections you want returned, 1 for manual, and 2 for saved search.
includeCountmixedOptionalfalse

Response

The response will be an array of items for each collection in the vhost. Each item will contain information about a collection.

NameTypeDescriptionDefault Values
idINTThe collection IDINT
vhostINTThe vhost ID that the collection belongs to.INT
thumbnailSTRINGA thumb url of an image to represent the collection.empty STRING
typeINTThis determines whether the collection is a saved search collection or a manual collection. Saved search is represented by 1 and manual collection by 2.1/2
nameSTRINGThe name of the collection. This is used for recognition of the channel.STRING
descriptionSTRINGAn overview of the media content that is in the collection.STRING
createdYYYY-MM-DD HH:MM:SSThe date the collection was created in our system.YYYY-MM-DD HH:MM:SS
baseurlSTRINGDEPRECATEDSTRING
channelINTThe channel that is used as a filter if the collection type is a saved search.empty / channel ID
addtotopINTWhen this is set the channel will be added to the top of the channel list.0/1
autoactiveINTThis sets the collection that it will be set as published as its default state.0/1

Return Values

FieldDescriptionPossible Values