Terug naar de indexpagina

SOAP API methode Collection_orderedField

Beschrijving

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

Naam Type Beschrijving
id * int Unique identifier (id) of the object Collection. The method only applies to the collection with this id.
login Structure of type 'login' Optional login data
access_token string Optional api access token
* verplichte parameters

Resultaat

Naam Type Beschrijving
collectionfield Structure of type 'collectionfield'

Structuur 'login'

Naam Type Beschrijving
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

Structuur 'collectionfield'

Naam Type Beschrijving
id int The ID of the collectionfield.
name string The name of the collectionfield.
weight int The weight of the collectionfield.
displayed boolean Is this collectionfield displayed?.
indatatable boolean Is this field added to the data table?
type string The type of this collectionfield.
value string The default value of this collectionfield.
specialcontent string The special content of this collectionfield.
big boolean Is this field a big field?
pixelwidth int The width of this collectionfield.
ordered boolean Is this collectionfield ordered by default?.
length integer Get the length of the collection field
lines integer Get the number of lines of the collection field
hidden boolean Is this a hidden field?
index boolean Is this field indexed?