SOAP API method Collection_specialContentField
Description
DEPRECATED Return a field that holds special content. The specialcontent is specially for sending mailings. The special content can be 'email', 'fax' or 'sms'.
Parameters
| Name | Type | Description |
|---|---|---|
| id * | int | Unique identifier (id) of the object Collection. The method only applies to the collection with this id. |
| specialContent * | string | The kind of field that is required: 'email', 'fax' or 'sms' |
| login | Structure of type 'login' | Optional login data (soon deprecated) |
| access_token | string | Optional api access token |
| * required parameters | ||
Return values
| Name | Type | Description |
|---|---|---|
| collectionfield | Structure of type 'collectionfield' |
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 'collectionfield'
| Name | Type | Description |
|---|---|---|
| id | int | The ID of the collectionfield. |
| name | string | The name of the collectionfield. |
| weight | int | The weight of the collectionfield. |
| displayed | boolean | Is this collectionfield displayed?. |
| indatatable | boolean | Is this field added to the data table? |
| type | string | The type of this collectionfield. |
| value | string | The default value of this collectionfield. |
| specialcontent | string | The special content of this collectionfield. |
| big | boolean | Is this field a big field? |
| pixelwidth | int | The width of this collectionfield. |
| ordered | boolean | Is this collectionfield ordered by default?. |
| length | integer | Get the length of the collection field |
| lines | integer | Get the number of lines of the collection field |
| hidden | boolean | Is this a hidden field? |
| index | boolean | Is this field indexed? |