Search

Quick links

• Input parameters
• Output
• Description
• Expected output
• Code snippet

Syntax for ‘searchFiles’ API:

Input parameters:

uid	username or email address
pwd	password
p	search location (folder path) in your account.
searchkey	search criteria
trash	set trash parameter to "yes” to locate files in trash

If you are using OAuth authentication method, uid and pwd are not required.

Output:

Below is a sample XML output generated during search operation:

<tree searchkey="*" message="SUCCESS" >
<item respath="/Data/putty.exe" size="454656" lmd="2010/05/24 02:06:00" ver="1" />
<item respath="/Data/AVUploadServlet.java" size="11562" lmd="2010/05/24 22:21:42" ver="1" /> <item respath="/Data/akv_go.gif" size="1265" lmd="2010/05/24 22:22:45" ver="1" />
</tree>

Description:

• tree
  Root node with attributes message and desc.
• message
  This attribute describes the operation as SUCCESS or FAIL.
• desc
  This attribute displays the error(s) that are generated during an invalid operation.
• item
  This is the child node with following attributes:
  
  • respath
    This attribute describes path of the file or folder searched.
  • size
    This attribute describes size of the resource.
  • lmd
    This attribute describes the last modified date of the resource.
  • ver
    This attribute describes the version (file version) of the resource.

Following cases explain the expected outputs during INVALID operations:

• Case 1: Empty Username or Password
  
  The output is as follows:
  <tree message="ERROR" desc="INVALID PARAMETERS"/>
• Case 2: Invalid Username or Password
  
  The output is as follows:
  <tree message="ERROR" desc="INVALID USER"/> Or
  <tree message="ERROR" desc="INVALID PASSWORD"/>
• Case 3: Invalid path
  
  The output is as follows:
  <tree message="ERROR" desc="INVALID PATH"/>
• Case 4: Account not configured
  
  Encryption configuration is a must for the IDriveSync account. If the configuration is not done for an account, the output is as follows:
  <tree message="ERROR" desc="ACCOUNT NOT YET CONFIGURED" configstatus="NOT SET"/>

Code snippets for Java, PHP, Python and Ruby:

Java:

PHP:

Python:

Ruby: