MAPI Manual

NAME

LIST_DIALOGMAP_TEMPLATE_STENCILS

FUNCTION

List stencils of a dialog map template

SYNOPSIS

dialogmap_template_id, search_limit

DESCRIPTION

This function allows users to list stencils of a dialog map template.

Required Parameters

* action: LIST_DIALOGMAP_TEMPLATE_STENCILS.

* dialogmap_template_id: ID of the dialog map template.

Optional Parameter

* 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.
* mcp_dialogmap_template_stencil_id: stencil ID.
* stencil_title: title of the stencil.
* stencil_description: description of the stencil.
* owner_mcp_user_id: ID of the user who created the stencil.
* creat_dt: date and time when the stencil was created.
* lastupdate_mcp_user_id: ID of the user by whom the stencil was last modified.
* last_update_dt: date and time the stencil 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_TEMPLATE_STENCILS&dialogmap_template_id=3&login_name=user@example.com&login_passwd=1111

Response:

<result tftype='1' infotype='0'>
    <resultset name='mcp_dialogmap_template_stencil' search_found_rows='1'>
        <row>
            <field name='mcp_org_id'>9000</field>
            <field name='mcp_dialogmap_template_id'>3</field>
            <field name='mcp_dialogmap_template_stencil_id'>1</field>
            <field name='stencil_title'>Demo: Ask customer rate service</field>
            <field name='stencil_description'>Just for demo</field>
            <field name='owner_mcp_user_id'>0</field>
            <field name='creat_dt'>0000-00-00 00:00:00</field>
            <field name='lastupdate_mcp_user_id'>0</field>
            <field name='last_update_dt'>0000-00-00 00:00:00</field>
        </row>
    </resultset>
</result>

TIPS

ENVIRONMENT

AUTHOR

YVN Tech

SEE ALSO

LIST_DIALOGMAP_TEMPLATES

Mweb v2.0 YVNTECH 2014