MAPI Manual

NAME

GET_COLUMN_INCONTACTBOOK

FUNCTION

Get a column of a contactbook

SYNOPSIS

contactbook_id, contactbook_column_id

DESCRIPTION

This function allows users to get the definition of a column from a contact book.  

Required Parameters

* action: GET_COLUMN_INCONTACTBOOK.
* contactbook_id: ID of the contact book.
* contactbook_column_id: ID of the column.

RETURN DATA

The response contains the following attributes:
*screen_title: specifies the title for the column on the screen.
*mcp_datatype_id: ID of the data type.
*report_title: report title of the column.
*column_screen_order: specifies in which sequence the column is placed on the screen.
*mcp_contactbook_fixcolumn_id: fixed ID of the column.
*type_name: data type.

ROLE PERMITTED

Manager

EXAMPLES

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

Request:
http://app02.yvntech.com/MapIHttpS/MapIS?action=GET_COLUMN_INCONTACTBOOK&contactbook_id=1&contactbook_column_id=1&login_name=name@example.com&login_passwd=1111

Response:
<result tftype='1' infotype='0'>
    <resultset name="mcp_contactbook_columns">
        <row>
            <field name="screen_title">name</field>
            <field name="mcp_datatype_id">1</field>
            <field name="report_title">name</field>
            <field name="column_screen_order">1</field>
            <field name="mcp_contactbook_fixcolumn_id">1001</field>
            <field name="type_name">TEXT</field>
        </row>
    </resultset>
</result>

TIPS

ENVIRONMENT

AUTHOR

YVN Tech

SEE ALSO

Mweb v2.0 YVNTECH 2014