SOAP API method Profile_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. If no match was found, a new subprofile can be created.
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'
- The collection to search in
- Parameter 'requirements' : Collection of type 'requirements'
- An array of requirement objects to search for subprofiles
- Parameter 'fields' : Collection of type 'fields'
- Associative array of new values for matching subprofiles
- Parameter 'create' : boolean
- Create a new subprofile based on the fields if no match was found
- Parameter 'caller' : Structure of type 'caller'
- The caller object (or null if called by old code)
- 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'
- The updated or created subprofiles
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 'pair'
This structure pair was mentioned above. This structure has the following properties:
- Property 'key' : string
- Property 'value' : string
Structure 'fields'
This structure fields was mentioned above. This structure has the following properties:
- Property 'pair' : Structure of type 'pair'
Structure 'caller'
This structure caller was mentioned above. This structure has the following properties:
- Property 'followups' : bool
- Are the follow-ups enabled
- Property 'caller' : string
- The name of the caller
- Property 'identity' : string|null
- The identity of the caller, this is the name that is accepted by the webcaller
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.