MAPI Manual

NAME

DELETE_COLUMN_FROMCONTACTBOOK

FUNCTION

Delete a column from contact book

SYNOPSIS

action: DELETE_COLUMN_FROMCONTACTBOOK
contactbook_id
contactbook_column_id
option_type

login_name
login_passwd
or  
login_name
session_id
or  
device_id

DESCRIPTION

This function allows users to delete a column from a contact book. Both GET and POST methods can be used to perform the request.

Required Parameters

* action: specifies the requested function. Sets to DELETE_COLUMN_FROMCONTACTBOOK.
* contactbook_id: ID of the contact book.
* contactbook_column_id: ID of the column. 
* option_type: if value is "DELETE_WITH_DATA", then the column and its data will be deleted; else only the column will be deleted. 

* 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. 
The response contains the following attribute:
* msg: a string indicating the column has been successfully deleted from the contact book.

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=DELETE_COLUMN_FROMCONTACTBOOK&contactbook_id=43&contactbook_column_id=1&option_type=DELETE_WITH_DATA&device_id=demoid

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

TIPS

ENVIRONMENT

AUTHOR

YVN Tech

SEE ALSO

Mweb v2.0 YVNTECH 2014