MAPI Manual

NAME

USERAPPS_LISTDATA

FUNCTION

User app list all key-value data

SYNOPSIS

app_id, keyword_set, ctime_from, ctime_to, return_range, order_by

DESCRIPTION

This function allows users to list all data associated with an application.

Required Parameters

* action: USERAPPS_LISTDATA.

* app_id: the application ID.


Optional Parameters

* keyword_set: searches the data which matches the given keyword set.

* ctime_from: the start time. It searches the data which is created between the start time and end time. The time is expressed as "YYYY-MM-DD HH:MM:SS". Special characters must be URL encoded.

* ctime_to: the end time.

* return_range: constrains the number of list results that are returned. It can also be used for pagination of list 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 list 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_by: the result can be ordered by "data_key", "data_value", or "last_update_dt".

RETURN DATA

The response contains the following attributes:

* mcp_userapps_data: contains the data for an app.

* data_key: key of the data.

* data_value: value of the data.

* last_update_dt: the date and time when the data was last updated.

ROLE PERMITTED

EXAMPLES

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

Request:

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

Response:

<result tftype='1' infotype='0'>
    <resultset name='mcp_userapps_data'>
        <row>
            <field name='data_key'>a</field>
            <field name='data_value'>manly</field>
            <field name='last_update_dt'>2015-03-03 16:22:07</field>
        </row>
        <row>
            <field name='data_key'>b</field>
            <field name='data_value'>bondi</field>
            <field name='last_update_dt'>2015-03-04 10:10:38</field>
        </row>
    </resultset>
</result>

TIPS

ENVIRONMENT

AUTHOR

YVN Tech

SEE ALSO

Mweb v2.0 YVNTECH 2014