MAPI Manual

NAME

GET_DIALOGMAP_TEMPLATE_STENCIL

FUNCTION

Get a stencil of a dialog map template

SYNOPSIS

dialogmap_template_id, dialogmap_template_stencil_id

DESCRIPTION

This function allows users to get the information of a stencil of a dialog map template. The results also contain the definitions of each node in the stencil represented by xlabels.

Required Parameters

* action: GET_DIALOGMAP_TEMPLATE_STENCIL.
* dialogmap_template_id: template ID of the dialog map.
* dialogmap_template_stencil_id: stencil ID.

RETURN DATA

The response contains the following attributes:
* mcp_org_id: organization ID.
* mcp_dialogmap_template_id: template ID of the dialog map.
* mcp_dialogmap_template_stencil_id: stencil ID of the dialog map.
* stencil_title: title of the stencil.
* mcp_dialogmap_template_xlabel_id_group: lists IDs of all the xlabels within the dialog map.
* owner_mcp_user_id: ID of the user who created the stencil.
* creat_dt: the timestamp when the stencil was created.
* lastupdate_mcp_user_id: ID of the user who last updated the stencil.
* last_update_dt: the timestamp when last update was made to the stencil.
* maptemplate_ui: image of the dialog map.
* mcp_dialogmap_template_xlabel: contains a list of xlabels.
* mcp_dialogmap_template_xlabel_id: xlabel ID.
* xlabel_title: title of the xlabel.
* xlabel_description: description of the xlabel.
* value_list: a list of values for the xlabel.
* xlabel_class: conditions on the value of the xlabel.

ROLE PERMITTED

Manager

EXAMPLES

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

Request:

http://app02.yvntech.com/MapIHttpS/MapIS?action=GET_DIALOGMAP_TEMPLATE_STENCIL&dialogmap_template_id=3&dialogmap_template_stencil_id=1&login_name=user@example.com&login_passwd=1111

Response:

<result tftype='1' infotype='0'>
    <resultset name="mcp_dialogmap_template_stencil">
        <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="mcp_dialogmap_template_xlabel_id_group">1,2,3,4,21,22,32,42,52,61,62,71,72</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>
            <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>
            <resultset name="mcp_dialogmap_template_xlabel">
                <row>
                    <field name="mcp_dialogmap_template_xlabel_id">1</field>
                    <field name="xlabel_title">NODE 1 contact group</field>
                    <field name="xlabel_description">Set contact group</field>
                    <field name="xlabel_datatype_id">25</field>
                    <field name="xlabel_ui" />
                    <field name="xlabel_scope">scope_map_node</field>
                    <field name="xlabel_field">recipient_list</field>
                    <field name="datasource_type">MCPTYPE_FROMINPUT</field>
                    <field name="default_value" />
                    <field name="value_list_type">MCPTYPE_FROMTXN</field>
                    <field name="value_list">___Select ...;;;1___default teamchat contactbook______2___team one;85___new test group four;164___demo group ;70___new team with app02;5___team three;21___myGroup;20___team Nov. 19th;;;31___testBookApril24______68___testContactGroupApril24;;;32___testContactBookApril28______69___testContactGroupApril28;;;40___default contact book______80___new test group one;86___new test group five;87___demo group one;90___demo group two;91___demo group three;81___new test group two;;;41___default contact book two______84___new test group three</field>
                    <field name="parent_xlabel_id">0</field>
                    <field name="enable_custom_child_options">1</field>
                    <field name="xlabel_class">uid_dt_notempty</field>
                </row>
                ...
                ...
            </resultset>
        </row>
    </resultset>
</result>

TIPS

ENVIRONMENT

AUTHOR

YVN Tech

SEE ALSO

LIST_DIALOGMAP_TEMPLATES, LIST_DIALOGMAP_TEMPLATE_STENCILS

Mweb v2.0 YVNTECH 2014