MAPI Manual

NAME

GET_USER_INFO

FUNCTION

Get user information

SYNOPSIS

user_login_name

DESCRIPTION

This function can be used to get the details of a user. A user can get their own information. Admin users are allowed to get the information of Manager users within the same organization. Account Manager user can get the information of all Admin users.

Required Parameters

* action: GET_USER_INFO.

Optional Parameters

* user_login_name: login name of the user.

RETURN DATA

The response contains the following attributes:
* user_id: user ID.
* login_name: login name of the user.
* group_id: ID of the group that the user belongs to.
* login_password: login password.
* userid_password: user ID password.
* first_name: first name of the user.
* middle_name: middle name.
* last_name: last name of the user.
* display_name: name of the user that is displayed.
* org_id: ID of the orgnisation that the user belongs to.
* is_active: status of the user.
* role: role of the user.
* create_time: date and time the user was created.
* access_control: specifies the access rights.
* access_apps_control: specifies which apps the user has access to.
* mcp_language_id: ID of the system language for the user.
* mcp_location_id: ID of the location.
* fax_number: fax number.
* mobile_1: mobile number of the user.
* org_department:
* org_position:
* tz_abbr: time zone abbreviation.
* extend_xml:

ROLE PERMITTED

Manager, Admin, Account Manager

EXAMPLES

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

Request:

http://app02.yvntech.com/MapIHttpS/MapIS?action=GET_USER_INFO&user_login_name=user@example.com&login_name=Admin@example.com&login_passwd=1111

Response:

<result tftype='1' infotype='0'>
    <resultset name="sys_user">
        <row>
            <field name="user_id">17010000</field>
            <field name="login_name">user@example.com</field>
            <field name="group_id">13010000</field>
            <field name="login_password" />
            <field name="userid_password" />
            <field name="first_name">Stephen</field>
            <field name="middle_name" />
            <field name="last_name">Smith</field>
            <field name="display_name">Stephen Smith</field>
            <field name="org_id">10000</field>
            <field name="is_active">1</field>
            <field name="role">manager</field>
            <field name="create_time">2013-06-13 15:31:23</field>
            <field name="access_control">1</field>
            <field name="access_apps_control">MCPTYPE_ALL</field>
            <field name="mcp_language_id">1</field>
            <field name="mcp_location_id">61</field>
            <field name="fax_number" />
            <field name="mobile_1">+61412345678</field>
            <field name="org_department" />
            <field name="org_position" />
            <field name="tz_abbr">TZ89</field>
            <field name="extend_xml" />
        </row>
    </resultset>
</result>

TIPS

ENVIRONMENT

AUTHOR

YVN Tech

SEE ALSO

Mweb v2.0 YVNTECH 2014