MAPI Manual

NAME

LIST_DIALOGMAP_TEMPLATES

FUNCTION

List dialog map templates

SYNOPSIS

user_id, keyword_set, search_limit

DESCRIPTION

This function allows users to list the dialog map templates.

Required Parameters

* action: LIST_DIALOGMAP_TEMPLATES.

Optional Parameters

* user_id: specifies ID of the user who created the template. Default will list all the dialog map templates that the user is allowed to access.
* keyword_set: searches the templates for keywords matching the given keyword set.
* search_limit: constrains the number of search results that are returned. It can also be used for pagination of search results. Value is a number or two numbers split by a comma. With one number, the value specifies the maximum number of results to return from the beginning of the search results. With two numbers, the first number specifies the offset of the first result to return, and the second specifies the maximum number of results to return. Note: The offset of the first result is 0 (not 1).  E.g., if value is "5", the first five search results will be returned; if value is "20,5", it will return maximum five results starting from the 21st result. Default value is 100.

RETURN DATA

The response contains the following attributes:
* mcp_org_id: organisation ID.
* mcp_dialogmap_template_id: template ID.
* maptemplate_name: name of the template.
* maptemplate_keyword: keywords of the template.
* maptemplate_ui: image for the template.
* owner_mcp_user_id: ID of the user who created the template.
* creat_dt: date and time when the template was created.
* lastupdate_mcp_user_id: ID of the user by whom the template was last modified.
* last_update_dt: date and time the template was last modified.

ROLE PERMITTED

Manager

EXAMPLES

The following example shows a successful HTTP GET request and response.

Request:

http://app02.yvntech.com/MapIHttpS/MapIS?action=LIST_DIALOGMAP_TEMPLATES&login_name=user@example.com&login_passwd=1111

Response:

<result tftype='1' infotype='0'>
    <resultset name='mcp_dialogmap_template' search_found_rows='19'>
        <row>
            <field name='mcp_org_id'>9000</field>
            <field name='mcp_dialogmap_template_id'>3</field>
            <field name='maptemplate_name'>Ask customer rate service</field>
            <field name='maptemplate_keyword'>rate service</field>
            <field name='maptemplate_ui'>&lt;map_img&gt;map_template_rateservice.jpg&lt;/map_img&gt;&lt;map_icon&gt;map_template_rateservice_icon.jpg&lt;/map_icon&gt;</field>
            <field name='owner_mcp_user_id'>0</field>
            <field name='creat_dt'>2014-09-03 11:43:51</field>
            <field name='lastupdate_mcp_user_id'>0</field>
            <field name='last_update_dt'>2014-09-03 11:43:51</field>
        </row>
        <row>
            <field name='mcp_org_id'>9000</field>
            <field name='mcp_dialogmap_template_id'>4</field>
            <field name='maptemplate_name'>Find a worker</field>
            <field name='maptemplate_keyword'>find job worker</field>
            <field name='maptemplate_ui'>&lt;map_img&gt;map_template_customer_findaworker.jpg&lt;/map_img&gt;&lt;map_icon&gt;map_template_customer_findaworker_icon.jpg&lt;/map_icon&gt;</field>
            <field name='owner_mcp_user_id'>0</field>
            <field name='creat_dt'>2014-09-03 11:43:51</field>
            <field name='lastupdate_mcp_user_id'>0</field>
            <field name='last_update_dt'>2014-09-03 11:43:51</field>
        </row>
        ...
        ...
        </resultset>
</result>

TIPS

ENVIRONMENT

AUTHOR

YVN Tech

SEE ALSO

LIST_DIALOGMAPS

Mweb v2.0 YVNTECH 2014