MAPI Manual

NAME

LIST_CONTACTBOOK_COLUMNS

FUNCTION

List columns of a contactbook

SYNOPSIS

action: LIST_CONTACTBOOK_COLUMNS
contactbook_id

login_name
login_passwd
or  
login_name
session_id
or  
device_id

DESCRIPTION

This function allows users to list the columns of a contact book. Both GET and POST methods can be used to perform the request.

Required Parameters

* action: specifies the requested function. Sets to LIST_CONTACTBOOK_COLUMNS.
* contactbook_id: ID 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. 
The response contains the following attributes:
* mcp_contactgroup_columns: contains a list of columns.
* mcp_org_id: ID of the organization to which the contact book belongs.
* mcp_contactbook_id: ID of the contact book.
* mcp_contactbook_column_id: ID of the column within the contact book.
* screen_title: title of the column shown on the screen.
* mcp_datatype_id: the data type ID of the column.
* mcp_datatype_name: the data type name of the column.
* report_title: title of the column shown on the report.
* column_screen_order: a number specifying in which sequence the column is placed on the screen.
* mcp_contactbook_fixcolumn_id: fixed ID of the column.

ROLE PERMITTED

EXAMPLES

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

Request:
http://app02.yvntech.com/MapIHttpS/MapIS?action=LIST_CONTACTBOOK_COLUMNS&contactbook_id=43&device_id=demoid

Response:
<result tftype='1' infotype='0'>
    <resultset name='mcp_contactgroup_columns'>
        <row>
            <field name='mcp_org_id'>10000</field>
            <field name='mcp_contactbook_id'>43</field>
            <field name='mcp_contactbook_column_id'>1</field>
            <field name='screen_title'>Firstname</field>
            <field name='mcp_datatype_id'>1</field>
            <field name='mcp_datatype_name'>TEXT</field>
            <field name='report_title'>fn</field>
            <field name='column_screen_order'>1</field>
            <field name='mcp_contactbook_fixcolumn_id'>1001</field>
        </row>
        <row>
            <field name='mcp_org_id'>10000</field>
            <field name='mcp_contactbook_id'>43</field>
            <field name='mcp_contactbook_column_id'>2</field>
            <field name='screen_title'>Mobile</field>
            <field name='mcp_datatype_id'>9</field>
            <field name='mcp_datatype_name'>MOBILE</field>
            <field name='report_title'>mobile</field>
            <field name='column_screen_order'>2</field>
            <field name='mcp_contactbook_fixcolumn_id'>1020</field>
        </row>
        <row>
            <field name='mcp_org_id'>10000</field>
            <field name='mcp_contactbook_id'>43</field>
            <field name='mcp_contactbook_column_id'>3</field>
            <field name='screen_title'>Email</field>
            <field name='mcp_datatype_id'>8</field>
            <field name='mcp_datatype_name'>EMAIL</field>
            <field name='report_title'>email</field>
            <field name='column_screen_order'>3</field>
            <field name='mcp_contactbook_fixcolumn_id'>1030</field>
        </row>
    </resultset>
</result>


TIPS

ENVIRONMENT

AUTHOR

YVN Tech

SEE ALSO

Mweb v2.0 YVNTECH 2014