get_entries_count
Overview
Retrieves a list of beans based on query specifications.
Available APIs
Definition
get_entries_count(session, module_name, query, deleted)
Parameters
| Name |
Type |
Description |
|---|
| session |
String |
Session ID returned by a previous login call. |
| module_name |
String |
The name of the module from which to retrieve records. Note: This is the modules key which may not be the same as the modules display name. |
| query |
String |
The SQL WHERE clause without the word "where". |
| deleted |
Integer |
If deleted records should be included in the results. |
Result
| Name |
Type |
Description |
|---|
| result |
get_entries_count_result | Array |
The call result. |
| result.result_count |
Integer |
The count of total records. |
Change Log
Examples
PHP
$get_entries_count_parameters = array(
//Session id
'session' => $session_id,
//The name of the module from which to retrieve records
'module_name' => 'Accounts',
//The SQL WHERE clause without the word "where".
'query' => " accounts.name like '%example text%' ",
//If deleted records should be included in results.
'deleted' => false
);