Terug naar de indexpagina

SOAP API methode Profile_searchContacts

Beschrijving

Search in the contacts of this profile for a string

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
searchString * string The string to search for in the contact moment
type string Where to search from the string: 'remarks', 'report' or 'both'
order string The order of the contact items
asc boolean Return in ascending or descending order
login Structure of type 'login' Optional login data
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
contact Collection of type 'contact'

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

Naam Type Beschrijving
id int The ID of the contact.