MAPI Manual

NAME

ADD_CONTACTBOOK

FUNCTION

Add a contact book

SYNOPSIS

contactbook_name, contactbook_type, contactbook_description, columns_xml

DESCRIPTION

This function allows users to add a contact book.

Required Parameters

* action: ADD_CONTACTBOOK.
* contactbook_name: name of the contact book.
* contactbook_type: type of the contact book. Value is either "org_level" or "user_level". Org_level means that the contact book is visible to other users within the same organization, but only the owner of the contact book can modify it. User_level means that the contact book is hidden from other users.

Optional Parameters

* contactbook_description: description of the contact book.
* columns_xml: XML representation of the column definitions.

RETURN DATA

The response contains the following attribute:
* mcp_contactbook_id: ID of the newly added contact book.

ROLE PERMITTED

All roles

EXAMPLES

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

Request:
http://app02.yvntech.com/MapIHttpS/MapIS?action=ADD_CONTACTBOOK&contactbook_name=NewContactBook&contactbook_type=org_level&contactbook_description=NewContactBook&columns_xml=&login_name=user@example.com&login_passwd=1111

Response:
<result tftype='1' infotype='0'>
        <field name='mcp_contactbook_id'>10</field>
</result>

TIPS

ENVIRONMENT

AUTHOR

YVN Tech

SEE ALSO

GET_CONTACTBOOK

Mweb v2.0 YVNTECH 2014