Full text customers search by string.
It returns only the Customers that the current User is allowed to see

@params:
q - is the full text search on all fields !!! Notice - setting this params will reduce the result to max 1000 records (1000 records that fullfil the fulltext search intersected to the rest of the parameters)

Pagination (2 different ways are possible):
== pagenr + limit (nr of records per page) - this has priority against the second way
== start + limit (as in MySQL syntax)

return_fields=firstname,lastname - comma separated, will return only the required fields

Searching multiple values: pipe separated (using OR)
firstname=atif|laurentiu|gert|helmut&lastname=ghaffar|nat

order_by=firstname,lastname,email
order_direction=ASC


@return
array customer data as Datatable Object


Saving the search as a filter:
@params saveByFilterName - if this parameter is set, the function will save the search as a filter
@params filter_category_id - assignes a category for the filter being saved with saveByFilterName. If saveByFilterName is given, but no filter_category_id, the new filter will be saved with a default category


Prospects search
@params only_prospects should be set on 1 to activate the search on prospects
@params Other available parameters are: project_id, employee_id, group_id, status_id, active


Search for newsletter
There are two params that can be used:
newsletter_subscribers and newsletter_id
@params newsletter_id id of the newsletter
if newsletter_id is ommited, then it searches clients that are or are not submitted to ANY newsletter
@params newsletter_subscribers: 0 = clients that ARE NOT subscribers, 1 = clients that are subscribers

Examples:
- Search clients who are not subscribed to ANY Basic Newsletters: newsletter_subscribers=1
- Search clients who are not subscribed to a specific Basic Newsletter: newsletter_subscribers=0
- Search clients who are subscribed to a specific Basic Newsletter: newsletter_subscribers=1&newsletter_id=123
- Search clients who are not subscribed to a specific Basic Newsletter: newsletter_subscribers=0&newsletter_id=123


@return Data Table object

(also Data Table args)

q	string
pagenr	integer (incl. search params)
start	integer (incl. search params)
limit	integer (incl. search params)
return_fields	string
order_by_specific_values	string
order_by	string
order_direction	string
reducer	string
filter_data	string
groups	string
groups_excluded	string
groups_restricted	string
assigned_date_operator	string
assigned_date_filter	string
client_number	string
client_uuid	string
id	integer (incl. search params)
company_id	integer (incl. search params)
nr	string
title	string
firstname	string
lastname	string
company	string
email	string
street	string
streetnr	string
addressextension1	string
addressextension2	string
zip	string
city	string
state	string
country	string
language	string
phone	string
fax	string
mobile	string
website	string
birthdate	string
ts	string
createtime	string
additionalfields	array
group_by	array
withPromotions	string
hasDocuments	string
isEmailOnly	string
saveByFilterName	string
iNewFilterCategory	string
saveByFilterId	integer
sSaveFilterData	string
requestStoredFilter	in: 0, 1
filter_category_id	integer (incl. search params)
currentFilterId	string
columnManager	string
is_registered	string
nomailbouncing	string
project_id	integer (incl. search params)
employee_id	string
group_id	integer (incl. search params)
status_id	string
active	integer (incl. search params)
only_prospects	integer (incl. search params)
searchFields	string
withOptinRules	string
basic_newsletter_id	alpha_dash
followup_newsletter_id	alpha_dash
basic_newsletter_subscribers	in: Include, Exclude
followup_newsletter_subscribers	in: Include, Exclude
selectedIds	ids
selectAll	string
exceptIds	ids
bEmsPreview	boolean
sPreviewLanguage	string
bPreviewLanguageExclude	boolean

Search clients by filter id

integer id - unique filter identifier
boolean requestStoredFilter - true value should be set for the further correct search by filter
in search method client model.
integer currentFilterId – field is added for the further correct search by filter in search method
client model and equals to unique filter identifier
Other parameters are: start, limit, company_id, user_id, sharedKey


@return Data Table object

(also Data Table args)

start	integer
limit	integer
id	integer, required
company_id	integer, required
user_id	integer, required
sharedKey	string

Get the badges for a client_id. Setting the badges is done in Settings/Crm/Badges

client_id

integer, required

Get files uploaded for one client
@param: id (id of the client)
@param: limit (default 5)

id	integer, required
limit	integer

Add groups to a client
@param number $id Id of the client
@param string $group_ids

id	ids, required
group_ids	ids, required
bUseQueues	boolean

Remove groups from a client
@param number $id Id of the client
@param string $group_ids

id	ids, required
group_ids	ids, required
bUseQueues	boolean

Import data
@param data - array of address Data
@param group_ids - group codes to be added
@param format - how the data is sent: possible values: json, serialized, base64serialized (base 64 encoded serialized array), array
@return nr of inserted rows

storage_key	string, required
group_ids	ids, required
register	boolean

Get all defined payment and bank data information for one client

id	integer, required

Set payment and bank data information for one client
@param number $id (this is client id)
@param string $paymethod (INVOICE, SEPA, PAYPAL)
@param string $iban ( max length 34 )
@param string $swift (SWIFT / BIC, maxlength 11)

client_id	integer, required
paymethod	string, required
bank_owner	max:100
bank_account	max:50
bank_clearing	max:50
bank_name	max:50
clearing_number	max:255
account_number	max:255
ribcode	max:11
guicode	max:11
vat_nr	max:50
iban	max:34
swift	max:11
sepa_authorized	integer
sepa_authorization_date	date
sepa_first_transaction	max:45
sepa_mandate_uploaded	integer
sepa_mandate_uploaded_changed	boolean

Check if an email is available.

This check can be done before adding a new client
required: email
returns {available:0} if the email is already used
returns {available:1} if the email is not used.

email

email, required

Change login / password for a client/company
required: id ( id of the client / company )
required: login
required: passwd

id	integer, required
login	string, required
passwd	string, required

language

alpha, max:2

client_id	integer
tag	string, required
language	alpha, max:2
company_id	integer

Change password for a client/company
required: id ( id of the client / company )
required: passwd

id	integer, required
passwd	string
login	string

company_id

integer, required

company_id

integer, required

company_id	numeric, required
fileSize	string, required
s3_key	string, required
originalName	string, required
delimiter	string
encoding	string
allowedColumns	string

client_number	integer
email	email
user_id	integer
company_id	integer
sharedKey	string

user_id	integer
company_id	string
sharedKey	string

Add one record

title	string, required
lastname	required_without_all:firstname, company, email
login	string
passwd	string
firstname	required_without_all:lastname, company, email
email	email, required_without_all:lastname, firstname, company
country	alpha, max:2
language	alpha, max:2, required
company	required_without_all:firstname, lastname, email
street	string
streetnr	string
send_email_after_registration	in: 0, 1
addressextension1	string
addressextension2	string
zip	string
city	string
state	string
nr	string
phone	string
fax	string
mobile	string
birthdate	date
vatin	max:22
vatnr	max:22
website	string
fields	array
allow_duplicate_email	string
is_registered	in: 0, 1
comment	string
client_uuid	string

ids	string, required
bDeleteRelatedData	in: 1, 0
company_id	integer, required

columns	string, required
keyword	string, required
limit	string, required
offset	string, required
bReturnIds	boolean
searchString	string

ids	string, required
getWithNumbers	boolean
withOptinRules	string

title	string, required
lastname	required_without_all:firstname, company, email
firstname	required_without_all:lastname, company, email
email	email, required_without_all:firstname, lastname, company
country	alpha, max:2
language	alpha, max:2, required
company	required_without_all:firstname, lastname, email
street	string
streetnr	string
addressextension1	string
addressextension2	string
zip	string
city	string
state	string
nr	string
phone	string
fax	string
mobile	string
birthdate	date
vatin	max:22
vatnr	max:22
website	string
client_number	string
client_uuid	string
fields	array
main_client_id	string, required
all_client_ids	string, required

ids

array

template_id	integer, required
included_ids	integer, required
datetime	date
newsletter_id	integer
newsletter_type	string
hardbounce	string
softbounce	string
only_unique_emails	string
sender_id	integer
selectAll	string
selectedIds	string
exceptIds	string

template_id	integer, required
excluded_ids	ids
included_ids	ids
date	date
selectAll	string
selectedIds	string
exceptIds	string
customerSearchString	string

template_id	integer, required
sender_id	integer
datetime	date
newsletter_id	integer
newsletter_type	string
hardbounce	string
softbounce	string
selectAll	string
selectedIds	string
exceptIds	string
customerSearchString	string

customerSearchString	string
selectAll	string
selectedIds	ids
exceptIds	ids
byField	string

columns	array
charset	required, in: utf, iso
selected	array
selectedAll	string
except	array
customerSearchString	string

ids	required, json
title	string
language	string
country	string
state	string
city	string
zip	string
is_registered	string
paymethod	string
fields	string

client_id	integer, required
file_id	integer, required
expires_hours	string

Get one record based on id

id	integer, required

Edit one record

id	integer, required
client_number	integer
client_uuid	string
title	string
login	string
passwd	string
lastname	string
firstname	string
company	string
city	string
state	string
nr	string
street	string
streetnr	string
addressextension1	string
addressextension2	string
zip	string
send_email_after_registration	in: 1
email	email
country	alpha, max:2
language	alpha, max:2
phone	string
fax	string
mobile	string
birthdate	string
vatin	max:22
vatnr	max:22
website	string
fields	array
nomail	integer
nomailbouncing	integer
is_registered	in: 0, 1
comment	string

Delete one record

bDeleteRelatedData	in: 1, 0
id	integer, required

Get Change Log for an object

id	integer, required

Get Comments related to an object -
@param id is the object id and not the comment id
@return Data Table object

(also Data Table args)

id	integer, required

Get one comment
@param id is the object id

id	integer, required
comment_id	integer, required

Add a comment to an object
@param id: id of the object to which a comment should be added
@param comment: text of the comment

id	integer, required
comment	string, required

Update a comment
@params comment_id is the id previously returned by getcomments
@param comment: text of the comment
@param id: id of the object to which a comment should be added

id	integer, required
comment_id	integer, required
comment	string, required

Delete a comment
@params comment_id is the id previously returned by getcomments

id	integer, required
comment_id	integer, required

dataTableMethod	string, required
sDatatableKey	string