SOAP API methode View_updateProfiles
Beschrijving
The requirements parameter contains a list of requirement objects that are used to search for matching profiles. Any matching profiles are then updated by the given values from the fields parameter. If no matching profiles were found, a new profile is created based on the fields parameter
Parameters
Naam | Type | Beschrijving |
---|---|---|
id * | int | Unique identifier (id) of the object View. The method only applies to the view with this id. |
requirements * | Collection of type 'requirements' | An array of requirement objects to search for profiles |
fields * | Collection of type 'fields' | Associative array of new values for matching profiles |
create | boolean | Should a new profile be created in case of a non-match |
async | boolean | Should this action be executed async? |
interests | Collection of type 'interests' | (Associative) array of interests for matching/new profile(s) |
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 |
profile | Collection of type 'profile' | The updated profiles |
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 'pair'
Naam | Type | Beschrijving |
---|---|---|
key | string | |
value | string |
Structuur 'fields'
Naam | Type | Beschrijving |
---|---|---|
pair | Structure of type 'pair' |
Structuur 'interests'
Naam | Type | Beschrijving |
---|---|---|
string |
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 'profile'
Naam | Type | Beschrijving |
---|---|---|
id | int | The ID of the profile. |