API Reference

Media.getFileInfo

Returns a list with information about the specified file.

If the userid parameter is supplied the uservote item is also returned, which contains the vote/rating the user made on the file (if any).

If you are not authenticated using the API key, you will only be able to retrieve information on moderated media.

There is no requirement for any permission to be able to retrieve information about a private media item.


Syntax

mixed media.getFileInfo ( mixed id, mixed uid = NULL, mixed returnComments = false, array options = array() )

Arguments

NameTypeRequiredDefault valueDescription
idmixedRequirednone
uidmixedOptionalNULL
returnCommentsmixedOptionalfalse
optionsarrayOptionalarray()

Sample Response

Sample REST Response
http://api.filemobile.com/services/rest/media/getFileInfo?id=[MEDIA_ID]
<?xml version="1.0" encoding="UTF-8"?>
<result>
  <id>MEDIA_ID</id>
  <status>3</status>
  <contenttype>text/plain</contenttype>
  <filetype>4</filetype>
  <context>1</context>
  <filename/>
  <injector>MediaService1</injector>
  <hits>0</hits>
  <message/>
  <date>2012-01-26 11:29:26</date>
  <title>thisisatitle</title>
  <tags/>
  <extension/>
  <sender/>
  <author/>
  <metadata/>
    <KEY>VALUE</KEY>
  <uid>USER_ID</uid>
  <filesize>0</filesize>
  <ofilesize>0</ofilesize>
  <upload>2012-01-26 11:29:26</upload>
  <location>fmdevs3</location>
  <originallocation/>
  <privacy>0</privacy>
  <moderationstatus>0</moderationstatus>
  <width>0</width>
  <height>0</height>
  <length>0.00</length>
  <conversiontime>0</conversiontime>
  <converttime/>
  <lastupdatetime>2012-01-26 11:29:26</lastupdatetime>
  <offensive>0</offensive>
  <autoblog>0</autoblog>
  <rating>0</rating>
  <votecount>0</votecount>
  <externalid/>
  <parentid>0</parentid>
  <originalLocation/>
  <user_name>USER_NAME</user_name>
  <user_email>EMAIL_ADDRESS</user_email>
  <user_country/>
  <user_city/>
  <user_state/>
  <user_nickname/>
  <user_firstname>FIRSTNAME</user_firstname>
  <user_lastname>LASTNAME</user_lastname>
  <url/>
  <vhost>VHOST_ID</vhost>
  <rotation>0</rotation>
  <language/>
  <channel>0</channel>
  <channel_shortname/>
  <channel_name/>
  <channelleft>0</channelleft>
  <geo_latitude/>
  <geo_longitude/>
  <originalsaved>1</originalsaved>
  <hidden>SHOWN</hidden>
  <commentcount>0</commentcount>
  <approvedcomments>0</approvedcomments>
  <notdeniedcomments>0</notdeniedcomments>
  <publicUrl>http://fmdevs3.filemobile.com/storage/MEDIA_ID</publicUrl>
  <thumbUrl>http://fmdev.s3.amazonaws.com/storage/MEDIA_ID</thumbUrl>
  <moderationdeniedid>0</moderationdeniedid>
  <conversions/>
  <isLive>false</isLive>
</result>
Sample JSON Response
{
    "status": true,
    "result": {
        "id": MEDIA_ID,
        "status": 3,
        "contenttype": "text/plain",
        "filetype": 4,
        "context": 1,
        "filename": "",
        "injector": "MediaService1",
        "hits": 0,
        "message": "",
        "date": "2012-01-26 11:29:26",
        "title": "thisisatitle",
        "tags": "",
        "extension": "",
        "sender": "",
        "author": "",
        "metadata": {
            "KEY": "VALUE"
        },
        "uid": USER_ID,
        "filesize": 0,
        "ofilesize": 0,
        "upload": "2012-01-26 11:29:26",
        "location": "fmdevs3",
        "originallocation": "",
        "privacy": 0,
        "moderationstatus": 0,
        "width": 0,
        "height": 0,
        "length": "0.00",
        "conversiontime": "0",
        "converttime": null,
        "lastupdatetime": "2012-01-26 11:29:26",
        "offensive": 0,
        "autoblog": "0",
        "rating": 0,
        "votecount": 0,
        "externalid": "",
        "parentid": 0,
        "originalLocation": "",
        "user_name": "USER_NAME",
        "user_email": "EMAIL_ADDRESS",
        "user_country": "",
        "user_city": "",
        "user_state": "",
        "user_nickname": "",
        "user_firstname": "FIRSTNAME",
        "user_lastname": "LASTNAME",
        "url": "",
        "vhost": VHOST_ID,
        "rotation": 0,
        "language": "",
        "channel": 0,
        "channel_shortname": null,
        "channel_name": null,
        "channelleft": 0,
        "geo_latitude": null,
        "geo_longitude": null,
        "originalsaved": 1,
        "hidden": "SHOWN",
        "commentcount": 0,
        "approvedcomments": 0,
        "notdeniedcomments": 0,
        "publicUrl": "http://fmdevs3.filemobile.com/storage/MEDIA_ID",
        "thumbUrl": "http://fmdev.s3.amazonaws.com/storage/MEDIA_ID",
        "moderationdeniedid": 0,
        "conversions": [],
        "isLive": "false"
    }
}

Code examples

0 comments

Be the first to comment on getFileInfo.

Add a Comment

  • captcha