File / Folder listing

Quick links

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

Syntax for 'browseFolder' API:

Input parameters:

uid	username or email address
pwd	password
p	resource (folder) path

Output:

Below is a sample XML output generated during file / folder listing:

<tree path="/Data/" message="SUCCESS" >
<item restype="1" resname="Myoffice.txt" size="9583" lmd="2010/05/26 01:58:57" ver="1" thumb="N"/>
<item restype="1" resname="history.xls" size="3631" lmd="2010/05/26 02:03:49" ver="1" thumb="N"/>
<item restype="1" resname="Outing.jpg" size="4737" lmd="2010/05/24 22:24:22" ver="1" thumb="Y"/>
</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:
  • restype
    This attribute describes whether the resource is a folder or a file.
  • resname
    This attribute describes the resource name.
  • 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.
  • thumb
    This attribute describes if a thumbnail exists or not for the file.

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 IDrive 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: