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
Parameter 'id' : int
Unique identifier (id) of the object Database. The method only applies to the database with this id.
Parameter 'type' : string
Type of contacts, extra value is 'all' to get all contacts
Parameter 'status' : string
Status of the contact, possible values are 'done', 'not done', 'expired' and 'all'
Parameter 'importance' : string
The importance of the contacts, possible values are 'all', 'important', 'not important'
Parameter '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
Parameter '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'.
Parameter '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
Parameter 'asc' : boolean
Sort order
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 'contact' : Collection of type 'contact'

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

Structure 'pair'
This structure pair was mentioned above. This structure has the following properties:
Property 'key' : string
Property 'value' : string

Structure 'datefilter'
This structure datefilter was mentioned above. This structure has the following properties:
Property 'pair' : Structure of type 'pair'

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 'contact'
This structure contact was mentioned above. This structure has the following properties:
Property 'id' : int
The ID of the contact.

Stay up to date

Receive our monthly top tips, the latest news about database marketing, email marketing, mobile and much more!

Try Copernica yourself!

  • Sign up in less than 30 seconds

  • Access to every feature

  • No upfront payment required

Try Copernica for free