SOAP API method Database_createField

Description
This method will create a new field into the database. The name of the field 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 Database. The method only applies to the database with this id.
Parameter 'name' : string
The name of the new field. This must be a valid identifier, and there should not already be a field, interest or collection with the same name.
Parameter 'type' : string
Type of field. Valid types are
Parameter 'value' : string
value
Parameter 'display' : boolean
display
Parameter 'ordered' : boolean
ordered
Parameter 'length' : integer
field length (only for text fields)
Parameter 'textlines' : integer
number of lines (only for text fields)
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 'field' : Structure of type 'field'
The field object that is created

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 '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?

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