SOAP API method CollectionField_collection

Back to API references

Description
This function return the Collection object that this field belongs to.

Parameters
Parameter 'id' : int
Unique identifier (id) of the object CollectionField. The method only applies to the collectionfield with this id.
Parameter 'login' : Structure of type 'login'
Optional login data

Return values
Return value 'collection' : Structure of type 'collection'

Structure 'login'
This structure login was mentioned above. This structure has the following properties:
Property 'username' : string
The username of the login attempt
Property 'account' : string
The account name of the login attempt
Property 'password' : string
The password for the login attempt

Structure 'collection'
This structure collection was mentioned above. This structure has the following properties:
Property 'id' : int
The ID of the collection.
Property 'name' : string
The name of the collection.
Property 'weight' : int
The weight of the collection.
Property 'created' : string
The date and time when the account was created.
Property 'unsubscribebehavior' : string
Get the unsubscribe behavior of the collection. Possible values are 'nothing', 'remove' or 'update'.
Property 'countsubprofiles' : int
The number of subprofiles.
Property 'lastbuilt' : timestamp
When was the item rebuilt for the last time?