Tuyu Developers

Developers

Customize the URLs on this site with your Tuyu URL:

https:// .
Method Documentation > Files and Folders

File Search (Within Location) GET

Description

Retrieves a page (up to 50 results of files/folders) of results based on the search criteria in a specific location.

URL

All responses are in JSON format by default, to specify an XML response add “.xml” to the end of the method name (in this case “file_search_location”)

https://<your subdomain>.<your domain>/api/file_search_location

Restrictions

The calling user must have:

  • Access to the requested location

Parameters

Bold indicates required. Please note parameters must be appended to the URL in alphabetical order, except for “signature”, which is always at the end.

Parameter Description
api_key Your API Key.
current_page Default is “1”, only necessary to grab subsequent pages of files/folders when the number of files/folders in a location exceeds 50.
path Location of the files. NOTE: This value must be URL-encoded. All paths must begin and end with “/”, with the exception of admins uploading into the site root, in which the path is simply “/”. Specific paths can be retrieved from file_list.
search_criteria Find all files matching this term in the specified location.
sort Default is “date_desc”. Other options include “date_asc”, “name_desc”, “name_asc”, “size_desc”, “size_asc”, “user_desc”, “user_asc”
timestamp The current time in Unix timestamp format.
signature Please see “User Authentication” for more information.

Sample Response

Successful response In JSON:

{"fileList":{
    "path":"\/","totalFiles":73,"filesInPage":50,"maxFilesPage":50,"files":[{
        "id":1071256,
        "name":"image1371675459160.jpg",
        "type":"file",
        "size":706638,
        "formattedSize":"690.08 KB",
        "path":"\/",
        "formattedModDate":"6\/19\/13, 4:57 pm EDT",
        "modDate":1371675460,
        "jobNumber":"0",
        "workspaceId":0,
        "username":"jsmith",
        "fileComments":3,
        "scheduledDelete":0,
        "restricted":0}
        ],
    "userSettings":{
        "admin":1,
        "uploadFiles":1,
        "batchUploadFiles":1,
        "downloadFiles":1,
        "batchDownloadFiles":1,
        "deleteFiles":1,
        "batchDeleteFiles":1,
        "moveCopyFiles":1,
        "batchMoveCopyFiles":1,
        "renameFiles":1,
        "createFolders":1,
        "sendFiles":1,
        "sendFilesNonUser":1,
        "subAdmin":0
    }
}}

Successful response in XML:

<fileList>
    <path>/</path>
    <totalFiles>73</totalFiles>
    <filesInPage>50</filesInPage>
    <maxFilesPage>50</maxFilesPage>
    <files>
        <file>
            <id>1071256</id>
            <name>image1371675459160.jpg</name>
            <type>file</type>
            <size>706638</size>
            <formattedSize>690.08 KB</formattedSize>
            <path>/</path>
            <formattedModDate>6/19/13, 4:57 pm EDT</formattedModDate>
            <modDate>1371675460</modDate>
            <jobNumber>0</jobNumber>
            <workspaceId>0</workspaceId>
            <username>jsmith</username>
            <fileComments>3</fileComments>
            <scheduledDelete>0</scheduledDelete>
            <restricted>0</restricted>
        </file>
    </files>
    <userSettings>
        <admin>1</admin>
        <uploadFiles>1</uploadFiles>
        <batchUploadFiles>1</batchUploadFiles>
        <downloadFiles>1</downloadFiles>
        <batchDownloadFiles>1</batchDownloadFiles>
        <deleteFiles>1</deleteFiles>
        <batchDeleteFiles>1</batchDeleteFiles>
        <moveCopyFiles>1</moveCopyFiles>
        <batchMoveCopyFiles>1</batchMoveCopyFiles>
        <renameFiles>1</renameFiles>
        <createFolders>1</createFolders>
        <sendFiles>1</sendFiles>
        <sendFilesNonUser>1</sendFilesNonUser>
        <subAdmin>0</subAdmin>
    </userSettings>
</fileList>

Error response In JSON:

{"error": {
    "title":"Authentication Failed",
    "message":"Authentication parameters missing or invalid."}
}

Error response In XML:

<error>
    <title>Authentication Failed</title>
    <message>Authentication parameters missing or invalid.</message>
</error>

Methods in Files and Folders