MAPI Manual

NAME

LIST_CONTACTBOOKS

FUNCTION

List contact books

SYNOPSIS

DESCRIPTION

This function allows users to list contact books. A contact book defines the contact columns for a contact group.

Required Parameters

* action: LIST_CONTACTBOOKS.

* search_limit: specifies a limit on the number of list results. It accepts two formats - either a number or two numbers separated by a comma. For example, if value is "5", the function will return the first five results to users; if value is "5,10", the function will return the results that are ordered within this range.


RETURN DATA

The response contains the following attributes:
* mcp_org_id: ID of the organization to which the contact book belongs.
* mcp_contactbook_id: the contact book ID.
* contactbook_type: type of the contact book.
* contactbook_name: name of the contact book.
* contactbook_description: description of the contact book.
* owner_mcp_user_id: ID of the user who created the contact book.
* creat_dt: the timestamp when the contact book was created.
* lastupdate_mcp_user_id: ID of the user who last updated the contact book.
* last_update_dt: the timestamp when last update was made to the contact book.

ROLE PERMITTED

EXAMPLES

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

Request:

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

Response:

<result tftype='1' infotype='0'>
    <resultset name='mcp_contactbooks'>
        <row>
            <field name='mcp_org_id'>10000</field>
            <field name='mcp_contactbook_id'>1</field>
            <field name='contactbook_type'>org_level</field>
            <field name='contactbook_name'>default app02 contactbook</field>
            <field name='contactbook_description'>for simple app02 </field>
            <field name='owner_mcp_user_id'>2010000</field>
            <field name='creat_dt'>2013-05-01 05:55:32</field>
            <field name='lastupdate_mcp_user_id'>2010000</field>
            <field name='last_update_dt'>2013-05-01 05:55:32</field>
        </row>
    </resultset>
</result>

TIPS

ENVIRONMENT

AUTHOR

YVN Tech

SEE ALSO

LIST_CONTACTGROUP_COLUMNS

Mweb v2.0 YVNTECH 2014