API Method: files.getList

Description

Returns all items in the site or user's file gallery.

Authentication

This method requires authentication without user credentials.

Required parameters

  • None

Optional parameters

  • file_id :
    the id number for the file
  • user_id :
    the id number for the user who owns this item
  • link :
    the path to the file which can be appended to the end of the site url (ex. http://SITENAME/LINK)
  • description :
    a description of the file
  • name :
    the name of the file
  • hash :
    the hash of the file
  • size :
    the size of the file
  • name :
    the name of the file
  • public :
    whether or not the file is public

Example response

<?xml version="1.0"?>
<response status="ok" time="Wed, 08 Apr 2009 09:40:16 -0500" p="0.012505054473877">
    <files count="12" total="12">
        <file>
            <user_id>3</user_id>
            <file_id>19</file_id>
            <link><![CDATA[/user_content/files/000/000/3]]></link>
            <hash><![CDATA[f4cc734e2c5869270bfc652ea96aa773]]></hash>
            <name><![CDATA[investag.pdf]]></name>
            ;<description><![CDATA[Testing from the api]]></description>
            <size>33023</size>
            <public>0</public>
            <comments>
                <comment>
                    <user_id>3</user_id>
                    <comment_id>1</comment_id>
                    <body>This is a test</body>
                    <last_update>Fri, 20 Mar 2009 14:34:15 -0500</last_update>
                </comment>
                <comment>
                    <user_id>8</user_id>
                    <comment_id>2</comment_id>
                    <body>Testing</body>
                    <last_update>Fri, 27 Mar 2009 17:34:56 -0500</last_update>
                </comment>
            </comments>
        </file>
        <file>
            <user_id>3</user_id>
            <file_id>20</file_id>
            <link><![CDATA[/user_content/files/000/000/3]]>
            </link><hash><![CDATA[9ccb4dd3622c8f57f5a58a77ea9c171e]]></hash>
            <name><![CDATA[ajnh_sso.doc]]></name>
            <description/>
            <size>104960</size>
            <public>1</public>
        </file
    </files>
</response>