SOAP API method ImportColumn_field
Description
The field in the database or collection that is associated with this column. This method returns a PxPomField object if the column holds profile data and a PxPomCollectionField object if the column holds subprofile data. The string 'id' is returned if the colunm holds the ID of a profile and the boolean value 'false' is returned if no field is associated with the column. If this columns is associated with an interest, an PxPomInterest object is returned.
Parameters
Name | Type | Description |
---|---|---|
id * | int | Unique identifier (id) of the object ImportColumn. The method only applies to the importcolumn with this id. |
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' | |
collectionfield | Structure of type 'collectionfield' | |
interest | Structure of type 'interest' |
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? |
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? |
Structure 'interest'
Name | Type | Description |
---|---|---|
id | int | The ID of this interest. |
name | string | The name of the interest. |
groupname | string | The name of the group that this interest belongs to. |
weight | int | The weight of the interest. |