MAPI Manual

NAME

LIST_DIALOGMAPS

FUNCTION

List dialog maps

SYNOPSIS

user_id, template_id, stencil_id, mark_status, search_limit, order_type

DESCRIPTION

This function allows users to list dialog maps.

Required Parameters

* action: LIST_DIALOGMAPS.

Optional Parameters

* user_id: user ID.
* template_id: template ID of the dialog map.
* stencil_id: stencil ID of the dialog map.

* mark_status: searches the dialog maps for status matching the given status list. If this value is empty, it represents the unused dialog maps. Available statuses are given below:

  • "LOCK": it means the dialog map has been locked.
  • "USED": it means the dialog map is in use.
* 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.
* order_type: specifies the list order of the results. Value is either "DESC" or "ASC", which means in descending or ascending order respectively.

RETURN DATA

The response contains the following attributes:
* mcp_dialogmap_id: dialog map ID.
* mcp_dialogmap_template_id: template ID of the dialog map.
* dialogmap_template_timestamp: date and time when the dialog map template was created.
* mcp_dialogmap_template_stencil_id: stencil ID of the dialog map.
* is_enable_upcontrol: "0" means upcontrol is disabled.
* title: title of the dialog map.
* description: description of the dialog map.
* mcp_mark_id: mark ID of the dialog map.
* map_defaultvalue: default value of the dialog map.
* owner_mcp_user_id: ID of the user who created the dialog map.
* creat_dt: date and time when the dialog map was created.
* lastupdate_mcp_user_id: ID of the user by whom the dialog map was last modified.
* last_update_dt: date and time the dialog map 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_DIALOGMAPS&login_name=user@example.com&login_passwd=1111

Response:

<result tftype='1' infotype='0'>
    <resultset name='mcp_dialogmap'>
         <row>
            <field name='mcp_dialogmap_id'>1352</field>
            <field name='mcp_dialogmap_template_id'>3</field>
            <field name='dialogmap_template_timestamp'>0000-00-00 00:00:00</field>
            <field name='mcp_dialogmap_template_stencil_id'>1</field>
            <field name='is_enable_upcontrol'>0</field>
            <field name='title'>Ask customer rate service</field>
            <field name='description'>Ask customer rate service</field>
            <field name='mcp_mark_id'></field>
            <field name='map_defaultvalue'></field>
            <field name='owner_mcp_user_id'>6009000</field>
            <field name='creat_dt'>2014-08-27 13:08:49</field>
            <field name='lastupdate_mcp_user_id'>6009000</field>
            <field name='last_update_dt'>2014-08-27 13:08:49</field>
        </row>
        ...
        ...
    </resultset>
</result>

TIPS

ENVIRONMENT

AUTHOR

YVN Tech

SEE ALSO

DIALOGMAP_GETMAP

Mweb v2.0 YVNTECH 2014