get_module_layout_md5
Overview
Retrieves the MD5 hash value for a layout given a specific module, type and view.
Available APIs
Definition
get_module_layout_md5(session, modules, types, views, acl_check)
Parameters
| Name |
Type |
Description |
|---|
| session |
String |
Session ID returned by a previous login call. |
| modules |
Array |
The list of modules to retrieve layouts for. |
| types |
Array |
The types of views requested. Current supported types are 'default' (for application) and 'wireless'. |
| views |
Array |
The views requested. Current supported types are 'edit', 'detail', 'list', and 'subpanel'. |
| acl_check |
Boolean |
Whether or not to check for ACL access. |
Result
| Name |
Type |
Description |
|---|
| result |
Array |
The call result. Contains a list of modules. |
| result[][$type] |
Array |
The list of types requested. |
| result[][$view] |
String |
The list of MD5 layout view hashes requested. |
Change Log
| Version |
Change |
|---|
| v3_1 |
Added acl_check parameter. |
| v3 |
Added get_module_layout_md5 method. |
Examples
PHP
$get_module_layout_md5_parameters = array(
//Session id
'session' => $session_id,
//The list of modules
'modules' => array(
'Accounts'
),
//The types of views requested
'types' => array(
'default',
),
//The views requested
'views' => array(
'edit'
),
//Whether or not to check for ACL access
'acl_check' => false,
);