MAPI Manual

NAME

GET_FILE_BYNAME

FUNCTION

Get the information of a file by file_name

SYNOPSIS

file_name

DESCRIPTION

This function allows users to get the information of a file by file_name.

Required Parameters

* action: GET_FILE_BYNAME.

* file_name: file name. Note: This is the file name defined by the system. Not the display name.

RETURN DATA

The response contains the following attributes:

* mcp_org_id: organisation ID.

* file_type: type of the file.

* mcp_org_file_id: file ID.

* file_name: file name in database.

* file_displayname: file name on screen.

* file_description: description of file.

* file_format: format of the file.

* owner_mcp_user_id: user who created the file.

* lastupdate_mcp_user_id: ID of the user by whom the file was last modified.

* last_update_dt: date and time the file was last modified.

* path_file: file path.

ROLE PERMITTED

Manager

EXAMPLES

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

Request:

http://app02.yvntech.com/MapIHttpS/MapIS?action=GET_FILE_BYNAME&file_name=9000.IVR_SOUND.116.1e732dc6978.mp3&login_name=user@example.com&login_passwd=1111

Response:

<result tftype='1' infotype='0'>
    <field name="mcp_org_id">9000</field>
    <field name="file_type">IVR_SOUND</field>
    <field name="mcp_org_file_id">116</field>
    <field name="file_name">9000.IVR_SOUND.116.1e732dc6978.mp3</field>
    <field name="file_displayname">test file three</field>
    <field name="file_description">test three</field>
    <field name="file_format">mp3</field>
    <field name="owner_mcp_user_id">6009000</field>
    <field name="creat_dt">2014-10-21 11:02:04</field>
    <field name="lastupdate_mcp_user_id">6009000</field>
    <field name="last_update_dt">2014-10-21 11:02:04</field>
    <field name="path_file">/mdcp/mcp/data/9000//sound/9000.IVR_SOUND.116.1e732dc6978.mp3</field>
</result>

TIPS

ENVIRONMENT

AUTHOR

YVN Tech

SEE ALSO

LIST_FILES

Mweb v2.0 YVNTECH 2014