SOAP API method Collection_createField

Back to API references

Description
This method will create a new field into the collection. The name of the collectionfield is mandatory, you can also give the type, the defaultvalue, the specialcontent, if the field has to be displayed and if ordered by this field.

Parameters
Parameter 'id' : int
Unique identifier (id) of the object Collection. The method only applies to the collection with this id.
Parameter 'name' : string
Name of the new field
Parameter 'type' : string
Type of field
Parameter 'value' : string
Default value
Parameter 'display' : boolean
Is the field displayed in overview pages?
Parameter 'ordered' : boolean
Is the field ordered in the overview
Parameter 'length' : integer
Field length
Parameter 'textlines' : integer
Number of text lines
Parameter 'hidden' : boolean
Is this field hidden
Parameter 'index' : boolean
is this field indexed
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?