Back to API references

SOAP API method Database_specialTypeField

Description

Return a field that is of a special type. Special types are used for sending mailings Types can be 'email', 'phone_fax', or 'phone_gsm'.

Parameters

Name Type Description
id * int Unique identifier (id) of the object Database. The method only applies to the database with this id.
type * string The type of field that is required
login Structure of type 'login' Optional login data (soon deprecated)
access_token string Optional api access token
* required parameters

Return values

Name Type Description
field Structure of type 'field'

Structure 'login'

Name Type Description
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

Structure 'field'

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