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
- Parameter 'id' : int
- Unique identifier (id) of the object Database. The method only applies to the database with this id.
- Parameter 'type' : string
- The type of field that is required
- Parameter 'login' : Structure of type 'login'
- Optional login data
Return values
- Return value 'field' : Structure of type 'field'
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?