SOAP API method ImportColumn_field

Back to API references

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
Parameter 'id' : int
Unique identifier (id) of the object ImportColumn. The method only applies to the importcolumn with this id.
Parameter 'login' : Structure of type 'login'
Optional login data

Return values
Return value 'field' : Structure of type 'field'
Return value 'collectionfield' : Structure of type 'collectionfield'
Return value 'interest' : Structure of type 'interest'

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?

Structure 'collectionfield'
This structure collectionfield was mentioned above. This structure has the following properties:
Property 'id' : int
The ID of the collectionfield.
Property 'name' : string
The name of the collectionfield.
Property 'weight' : int
The weight of the collectionfield.
Property 'displayed' : boolean
Is this collectionfield displayed?.
Property 'indatatable' : boolean
Is this field added to the data table?
Property 'type' : string
The type of this collectionfield.
Property 'value' : string
The default value of this collectionfield.
Property 'specialcontent' : string
The special content of this collectionfield.
Property 'big' : boolean
Is this field a big field?
Property 'pixelwidth' : int
The width of this collectionfield.
Property 'ordered' : boolean
Is this collectionfield ordered by default?.
Property 'length' : integer
Get the length of the collection field
Property 'lines' : integer
Get the number of lines of the collection field
Property 'hidden' : boolean
Is this a hidden field?
Property 'index' : boolean
Is this field indexed?

Structure 'interest'
This structure interest was mentioned above. This structure has the following properties:
Property 'id' : int
The ID of this interest.
Property 'name' : string
The name of the interest.
Property 'groupname' : string
The name of the group that this interest belongs to.
Property 'weight' : int
The weight of the interest.