WebCrmApiRetrieveByQuery Method |
Returns data basing on the given SELECT SQL parameters.
Namespace: dk.webCRM.ApiSync.WebServiceAssembly: dk.webCRM.ApiSync.WebService (in dk.webCRM.ApiSync.WebService.dll) Version: 2.0.0.5 (2.0.0.5)
Syntaxpublic RetrieveByQueryResult RetrieveByQuery(
string selectFields,
string tables,
string whereClause,
string orderBy
)
Public Function RetrieveByQuery (
selectFields As String,
tables As String,
whereClause As String,
orderBy As String
) As RetrieveByQueryResult
public:
RetrieveByQueryResult^ RetrieveByQuery(
String^ selectFields,
String^ tables,
String^ whereClause,
String^ orderBy
)
member RetrieveByQuery :
selectFields : string *
tables : string *
whereClause : string *
orderBy : string -> RetrieveByQueryResult
Parameters
- selectFields
- Type: SystemString
A comma separated list of field names.
Expressions and field aliases are not enabled. - tables
- Type: SystemString
A single table name or a JOIN expression
of any sort (INNER, LEFT, RIGHT or FULL).
It may not include any sub queries. The expression in ON section
must include only the following operations and functions:
NOT, AND, OR, =, >, <, >=, <=, <>, LIKE, IS, UPPER, LOWER and LEN.
It is enabled using string values, numbers and NULL. - whereClause
- Type: SystemString
A filter expression. It must include only the following
operations and functions:
NOT, AND, OR, =, >, <, >=, <=, <>, LIKE, IS, UPPER, LOWER and LEN.
It is enabled using string values, numbers and NULL.
Operations may be groupped by brackets "(" and ")". - orderBy
- Type: SystemString
A comma separated list of field names with ASC and DESC options.
Return Value
Type:
RetrieveByQueryResult
Examples
WebCrmApiSoapClient proxy = new WebCrmApiSoapClient();
ErrorStatus errorStatus;
TicketHeader ticket = proxy.Authenticate("cm1111aaaaaa", "username", "password", out errorStatus);
RetrieveByQueryResult result = proxy.RetrieveByQuery(
ticket, "p_name, p_email", "person", "p_email<>''", "p_name");
See Also