SOAP API method Profile_searchSubProfiles

Back to API references

Description
Searches subprofiles in an certain field, note that this field must be a collection witch could keep subprofiles. By giving the collection field or ID the search can be specified by an assocc array (optional is the operator witch is standard set at equal).

Parameters
Parameter 'id' : int
Unique identifier (id) of the object Profile. The method only applies to the profile with this id.
Parameter 'timestamp' : string
The timestamp for the historic profile
Parameter 'collection' : Structure of type 'collection'
Parameter 'requirements' : Collection of type 'requirements'
Parameter 'order' : string
Parameter 'asc' : boolean
Parameter 'login' : Structure of type 'login'
Optional login data
Parameter 'start' : int (optional)
Optional parameter that specifies the first element in the collection to be returned. If this parameter is omitted, the first entry in the collection is also the first entry that is returned. Use this parameter is you only want to retrieve a part of the collection.
Parameter 'length' : int (optional)
Optional parameter that can be used to limit the number of returned elements of this method. If this parameter is omitted, all entries in the collection are returned. If you specify a length, this method will not return more than the specified number of entries.
Parameter 'allproperties' : boolean (optional)
Optional parameter that specifies if only a limited number of properties of the requested objects are returned or, when this parameter is set to true, whether all properties of the objects are returned.

Return values
Return value 'start' : int
The first element of the collection
Return value 'length' : int
The number of elements that are returned
Return value 'total' : int
The total available elements of the collection
Return value 'allproperties' : int
When this element is available in the return value, the objects in the collection are fully filled, otherwise only a limited number of fields from the objects are filled
Return value 'subprofile' : Collection of type 'subprofile'

Structure 'collection'
This structure collection was mentioned above. This structure has the following properties:
Property 'id' : int
The ID of the collection.
Property 'name' : string
The name of the collection.
Property 'weight' : int
The weight of the collection.
Property 'created' : string
The date and time when the account was created.
Property 'unsubscribebehavior' : string
Get the unsubscribe behavior of the collection. Possible values are 'nothing', 'remove' or 'update'.
Property 'countsubprofiles' : int
The number of subprofiles.
Property 'lastbuilt' : timestamp
When was the item rebuilt for the last time?

Structure 'requirement'
This structure requirement was mentioned above. This structure has the following properties:
Property 'fieldname' : string
The name of the field.
Property 'casesensitive' : boolean
Is the comparison case sensitive.
Property 'operator' : string
The operator to use, the possible operators are '=','!=','<>','LIKE', 'NOT LIKE', '<','>','<=','>=','CONTAINS'.
Property 'value' : string
The value of the requirement.

Structure 'requirements'
This structure requirements was mentioned above. This structure has the following properties:
Property 'requirement' : Structure of type 'requirement'

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 'subprofile'
This structure subprofile was mentioned above. This structure has the following properties:
Property 'id' : int
The ID of the subprofile.