SOAP API method Database_contacts

Description

All contacts in this source of profiles. There can be applied a filter for the type, the status,

Parameters

Name	Type	Description
id *	int	Unique identifier (id) of the object Database. The method only applies to the database with this id.
type	string	Type of contacts, extra value is 'all' to get all contacts
status	string	Status of the contact, possible values are 'done', 'not done', 'expired' and 'all'
importance	string	The importance of the contacts, possible values are 'all', 'important', 'not important'
user	Structure of type 'user'	The user who should take the action, as an ID, an object or a name. If not specified contacts for all users are returned
datefilter	Collection of type 'datefilter'	Extra date filter options. This is an associative array that can have a min and a max key, to filter out the contacts between certain dates. The keys contains 'minplannedtime', 'maxplannedtime', 'minexecutedtime', 'maxexecutedtime'.
order	boolean	Order in which the should be returned, value is the ID of the field that should be ordered If 'false': the contacts are ordered by time
asc	boolean	Sort order
includeSubprofile	boolean	Include subprofile-based contacts?
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
contact	Collection of type 'contact'

Structure 'user'

Name	Type	Description
id	int	The ID of the user.
created	timestamp	The timestamp when the user is created.
end	timestamp	The timestamp when the user is ended.
gender	string	The gender of the user.
name	string	The name of the user.
description	string	The description of the user.
email	string	The email address of the user.
phone	string	The phone number of the user.
sms	string	The sms number of the user.
fax	string	The fax number of the user.
applicationadmin	boolean	Returns if the user is application admin.
accountadmin	boolean	Returns if the user is account admin.
styleadmin	boolean	Returns if the user is style admin.
dummy	boolean	Returns if the user is a dummy user.
apiaccess	boolean	Returns if the user has access to the API.
uiacess	boolean	Returns if the user has access to the user interface.
disabled	boolean	Is this user disabled?.
active	boolean	Is this user active?
receivenews	boolean	Will this user receive the news?.
language	string	The prefered language of the user.
timezone	string	Get the timezone for the user. If no timezone is set an empty string is returned.
unsecure	boolean	Is this an insecure user?.

Structure 'pair'

Name	Type	Description
key	string
value	string

Structure 'datefilter'

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

Name	Type	Description
id	int	The ID of the contact.