SOAP API methode Profile_searchSubProfiles

Beschrijving

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

Parameters

Naam	Type	Beschrijving
id *	int	Unique identifier (id) of the object Profile. The method only applies to the profile with this id.
timestamp	string	The timestamp for the historic profile
collection	Structure of type 'collection'
miniview	Structure of type 'miniview'
requirements *	Collection of type 'requirements'
order	string
asc	boolean
login	Structure of type 'login'	Optional login data (soon deprecated)
access_token	string	Optional api access token
start	int	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.
length	int	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.
allproperties	boolean	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.
* verplichte parameters

Resultaat

Naam	Type	Beschrijving
start	int	The first element of the collection
length	int	The number of elements that are returned
total	int	The total available elements of the collection
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
subprofile	Collection of type 'subprofile'

Structuur 'collection'

Naam	Type	Beschrijving
id	int	The ID of the collection.
name	string	The name of the collection.
weight	int	The weight of the collection.
created	string	The date and time when the account was created.
unsubscribebehavior	string	Get the unsubscribe behavior of the collection. Possible values are 'nothing', 'remove' or 'update'.
countsubprofiles	int	The number of subprofiles.

Structuur 'miniview'

Naam	Type	Beschrijving
id	int	The ID of the miniview.
name	string	The name of the miniview.
description	string	The description of the miniview.
buildstatus	string	The status of the rebuild
countsubprofiles	int	The number of subprofiles.

Structuur 'requirement'

Naam	Type	Beschrijving
fieldname	string	The name of the field.
casesensitive	boolean	Is the comparison case sensitive.
operator	string	The operator to use, the possible operators are '=','!=','<>','LIKE', 'NOT LIKE', '<','>','<=','>=','CONTAINS'.
value	string	The value of the requirement.

Structuur 'requirements'

Naam	Type	Beschrijving
requirement	Structure of type 'requirement'

Structuur 'login'

Naam	Type	Beschrijving
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

Structuur 'subprofile'

Naam	Type	Beschrijving
id	int	The ID of the subprofile.