MAPI Manual

NAME

UPDATE_CONTACTBOOK_EXCEPTCOLUMNS

FUNCTION

Update a contact book without changing columns

SYNOPSIS

action: UPDATE_CONTACTBOOK_EXCEPTCOLUMNS
contactbook_id
contactbook_name
contactbook_type
contactbook_description

login_name
login_passwd
or  
login_name
session_id
or  
device_id

DESCRIPTION

This function allows users to update the details of a contact book without changing its columns. Both GET and POST methods can be used to perform the request. 

Required Parameters

* action: specifies the requested function. Sets to UPDATE_CONTACTBOOK_EXCEPTCOLUMNS.
* contactbook_id: ID of the contact book that needs to updated.
* contactbook_name: name of the contact book.
* contactbook_type: type of the contact book. Types are 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.
* contactbook_description: description of the contact book.

* login_name: the login name for authenticating the user.
* login_passwd: the login password for authenticating the user.
or
* login_name: the login name for authenticating the user.
* session_id: the session ID for authenticating the user.
or
* device_id: a unique ID of the device. The system can use it as a key to identify users. 

RETURN DATA

For each valid request, the server provides a response in XML format, wrapped within a <result> tag. 
The response contains the following attribute:
* msg: a string indicating the contact book has been updated successfully.

For an invalid request, the response XML contains the following attribute:
* msg: a string containing the error message. 

ROLE PERMITTED

EXAMPLES

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

Request:
http://app02.yvntech.com/MapIHttpS/MapIS?action=UPDATE_CONTACTBOOK_EXCEPTCOLUMNS&contactbook_id=13&contactbook_name=ContactBookUpdated&contactbook_type=user_level&contactbook_description=ContactBookUpdated&device_id=demoid

Response:
<result tftype='1' infotype='0'>
    <field name='msg'>SUCCESS</field>
</result>

TIPS

ENVIRONMENT

AUTHOR

YVN Tech

SEE ALSO

UPDATE_COLUMN_INCONTACTBOOK

Mweb v2.0 YVNTECH 2014