Let the platform do the work
SugarClubContact+1 (877) 842-7276

get_module_layout

Overview

Retrieves the layout metadata for a given module given a specific type and view.

Available APIs

  • REST

Definition

get_module_layout(session, modules, types, views, acl_check, md5)

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.
md5 Boolean Setting this to true will return an MD5 hash of the modules layouts instead of the layouts themselves.

Result

Name Type Description
result Array The call result. Contains a list of modules.
result[][$type] Array The list of types requested.
result[][$view] Array or String The list of layout views requested or MD5 hashes. This is dependent on the 'md5' parameter.

Change Log

Version Change
v3_1 Added acl_check parameter.
v3 Added get_module_layout method.

Examples

PHP

$get_module_layout_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,

    //Whether to return the results as an MD5 hash
    'md5' => true,
);

Topics