Folder details

Retrieve details of particular folders in your IDrive account using the getFolderDetails API.

Quick links

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

Syntax for ‘getFolderDetails’ API:

HTTP method: POST

Input parameters:

uid	username or email address
pwd	password
p	folder path name (in your account)

Output:

Below is a sample XML output generated during this API call:

<tree path="/Data/" message="SUCCESS" size="1363932" filecount="13" />

Description:

• tree
  Root node with attributes message, size, filecount and desc.
• message
  This attribute describes the operation as SUCCESS or FAIL.
• filecount
  This attribute displays the total number of files that are available within a folder.
• desc
  This attribute displays the error(s) that are generated during an invalid operation.
• size
  Total size of the folder in bytes.

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: