SOAP API method Collection_orderedField

Description
In a collection one field can be assigned to be 'ordered by default'. When the collection is displayed, the subprofiles will be displayed ordered on this field. This method returns the collectionfield that is ordered by default, or false if no field was assigned.

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

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

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 'collectionfield'
This structure collectionfield was mentioned above. This structure has the following properties:
Property 'id' : int
The ID of the collectionfield.
Property 'name' : string
The name of the collectionfield.
Property 'weight' : int
The weight of the collectionfield.
Property 'displayed' : boolean
Is this collectionfield displayed?.
Property 'indatatable' : boolean
Is this field added to the data table?
Property 'type' : string
The type of this collectionfield.
Property 'value' : string
The default value of this collectionfield.
Property 'specialcontent' : string
The special content of this collectionfield.
Property 'big' : boolean
Is this field a big field?
Property 'pixelwidth' : int
The width of this collectionfield.
Property 'ordered' : boolean
Is this collectionfield ordered by default?.
Property 'length' : integer
Get the length of the collection field
Property 'lines' : integer
Get the number of lines of the collection field
Property 'hidden' : boolean
Is this a hidden field?
Property 'index' : boolean
Is this field indexed?

Stay up to date

Receive our monthly top tips, the latest news about database marketing, email marketing, mobile and much more!

Try Copernica yourself!

  • Sign up in less than 30 seconds

  • Access to every feature

  • No upfront payment required

Try Copernica for free