collections.getCollectionByName

Syntax

INTEGER collections.getCollectionByName ( INTEGER vhost = NULL, mixed collectionName = NULL )

Argument Info

NameTypeRequiredDefault valueDescription
vhostINTEGEROptionalNULLThe vhost ID that the collection belongs to.
collectionNamemixedOptionalNULL

Response

The response for the search.

NameTypeDescriptionDefault Values
resultINTUpon success, the response will be the id of the collection. if no such collection is found, then 0 is returned.INTEGER = success / 0 = no such collection was found

Return Values

FieldDescriptionPossible Values