MAPI Manual

NAME

GET_CONTACTGROUP

FUNCTION

Get the definition of a contact group

SYNOPSIS

contactgroup_id

DESCRIPTION

This function allows users to retrieve the details of a contact group.

Required Parameters

* action: GET_CONTACTGROUP.
* contactgroup_id: ID of the contact group.

RETURN DATA

The response contains the following attributes:
* mcp_contactgroup_id: ID of the contact group.
* mcp_contactbook_id: ID of the contact book that defines the columns of the contact group.
* contactgroup_type: type of the contact group.
* contactgroup_name: name of the contact group.
* contactgroup_description: description of the contact group.

ROLE PERMITTED

Manager

EXAMPLES

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

Request:
http://app02.yvntech.com/MapIHttpS/MapIS?action=GET_CONTACTGROUP&contactgroup_id=134&login_name=user@example.com&login_passwd=1111

Response:
<result tftype='1' infotype='0'>
    <field name='mcp_contactgroup_id'>134</field>
    <field name='mcp_contactbook_id'>1</field>
    <field name='contactgroup_type'>org_level</field>
    <field name='contactgroup_name'>NewTestTeam</field>
    <field name='contactgroup_description'>NewlyAddedGroup</field>
</result>

TIPS

ENVIRONMENT

AUTHOR

YVN Tech

SEE ALSO

LIST_CONTACTGROUP_COLUMNS

Mweb v2.0 YVNTECH 2014