Back to API references

SOAP API method Database_collection

Description

The ID or name of a collection can be given as parameter. This method returns 'false' if the supplied collection is not in the database, or the Collection object if the database does hold the collection.

Parameters

Name Type Description
id * int Unique identifier (id) of the object Database. The method only applies to the database with this id.
identifier * string
login Structure of type 'login' Optional login data (soon deprecated)
access_token string Optional api access token
* required parameters

Return values

Name Type Description
collection Structure of type 'collection'

Structure 'login'

Name Type Description
username string The username of the login attempt
account string The account name of the login attempt
password string The password for the login attempt

Structure 'collection'

Name Type Description
id int The ID of the collection.
name string The name of the collection.
weight int The weight of the collection.
created string The date and time when the account was created.
unsubscribebehavior string Get the unsubscribe behavior of the collection. Possible values are 'nothing', 'remove' or 'update'.
countsubprofiles int The number of subprofiles.
lastbuilt timestamp When was the item rebuilt for the last time?