MAPI Manual

NAME

LIST_MODULES

FUNCTION

List system modules

SYNOPSIS

action: LIST_MODULES

login_name
login_passwd 
or 
login_name 
session_id 
or 
device_id

DESCRIPTION

This function allows users to get a list of system modules. Every function can be mapped to a specific system module. Both GET and 
POST methods can be used to perform the request.

Required Parameters

* action: specifies the requested function. Sets to LIST_MODULES.

* login_name: the login name for authenticating the user.
* login_passwd: the login password for authenticating the user.
or
* login_name: the login name for authenticating the user.
* session_id: the session ID for authenticating the user.
or
* device_id: a unique ID of the device. The system can use it as a key to identify users.

RETURN DATA

For each valid request, the server provides a response in XML format, wrapped within a <result> tag. 
The response contains the following attributes:
* mcp_module: contains a list of system modules.
* mcp_module_id: ID of the module.
* module_name: name of the module.
* module_description: description of the module.
* module_type: type of the module.

For an invalid request, the response XML contains the following attribute:
* msg: a string containing the error message. 

ROLE PERMITTED

EXAMPLES

The following example shows a successful HTTP GET request and response. Note: the response is incomplete.

Request:
http://app02.yvntech.com/MapIHttpS/MapIS?action=LIST_MODULES&device_id=mytestid

Response:
<result tftype='1' infotype='0'>
    <resultset name='mcp_module'>
        <row>
            <field name='mcp_module_id'>10</field>
            <field name='module_name'>system</field>
            <field name='module_description'>system module</field>
            <field name='module_type'>0</field>
        </row>
        <row>
            <field name='mcp_module_id'>101</field>
            <field name='module_name'>user</field>
            <field name='module_description'>user module</field>
            <field name='module_type'>0</field>
        </row>
        <row>
            <field name='mcp_module_id'>1001</field>
            <field name='module_name'>broadcast</field>
            <field name='module_description'>broadcast module</field>
            <field name='module_type'>0</field>
        </row>
        <row>
            <field name='mcp_module_id'>1002</field>
            <field name='module_name'>service</field>
            <field name='module_description'>service module</field>
            <field name='module_type'>0</field>
        </row>
        ...
        ...
        ...
    </resultset>
</result>

TIPS

ENVIRONMENT

AUTHOR

YVN Tech

SEE ALSO

Mweb v2.0 YVNTECH 2014