SOAP API method Collection_updateSubProfiles

Description

The requirements parameter contains a list of requirement objects that are used to search for matching subprofiles. Any matching subprofiles are then updated by the given values from the fields parameter.

Parameters

Name	Type	Description
id *	int	Unique identifier (id) of the object Collection. The method only applies to the collection with this id.
requirements *	Collection of type 'requirements'	An array of requirement objects to search for subprofiles
fields *	Collection of type 'fields'	Associative array of new values for matching subprofiles
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.
* required parameters

Return values

Name	Type	Description
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'	The updated subprofiles

Structure 'requirement'

Name	Type	Description
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.

Structure 'requirements'

Name	Type	Description
requirement	Structure of type 'requirement'

Structure 'pair'

Name	Type	Description
key	string
value	string

Structure 'fields'

Name	Type	Description
pair	Structure of type 'pair'

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 'subprofile'

Name	Type	Description
id	int	The ID of the subprofile.