SOAP API method PartMiniCondition_addField

Back to API references

Description
The field is the name or id of the field. This method return true on success and else false. I the position is nog given the fields is placed after the last field in the minicondition

Parameters
Parameter 'id' : int
Unique identifier (id) of the object PartMiniCondition. The method only applies to the partminicondition with this id.
Parameter 'field' : Structure of type 'field'
The id of the field
Parameter 'sort' : string
Sort type (numeric|string).
Parameter 'order' : string
The sort order used. Possible values are 'asc' end 'desc'
Parameter 'position' : int
The position of the field.This must be a positive number. Is not give the field is paced at the end.
Parameter 'login' : Structure of type 'login'
Optional login data

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

Structure 'field'
This structure field was mentioned above. This structure has the following properties:
Property 'id' : int
The ID of the field.
Property 'name' : string
The name of the field.
Property 'big' : boolean
Is this field a big field?.
Property 'pixelwidth' : int
The width of this field.
Property 'weight' : int
The weight of this field.
Property 'type' : string
The type of this field.
Property 'value' : string
The default value of this field.
Property 'specialcontent' : string
The special content of this field.
Property 'ordered' : boolean
Is this the field that we order by by default?
Property 'displayed' : boolean
Is this field displayed?
Property 'indatatable' : boolean
Is this field added to the data table?
Property 'length' : integer
Get the length of the field
Property 'lines' : integer
Get the number of lines in this field
Property 'hidden' : boolean
Is this field hidden?
Property 'index' : boolean
Is this field indexed?

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 'partminiconditionfield'
This structure partminiconditionfield was mentioned above. This structure has the following properties:
Property 'id' : string
The ID of the PartMiniConditionField.
Property 'order' : string
The order this field will be sorted on.
Property 'sortingtype' : string
The type of sorting.