GET api/Files/{id}/Documents/Folders

Retrieves the list of document folders for a file.

Request

Parameters

Name Description Default
id Unique file ID.
includeRelatedFiles Whether to include folders on related files. False

Response

Body

Content Type: application/xml or application/json
List of folders or an error message.

XML JSON 
<Response>                               
  <Result>                               <!--Array of 'Item'--> 
    <Item>                               
      <ID>string</ID>                    <!--Unique folder ID--> 
      <FolderPath>string</FolderPath>    <!--Path name (backslash-delimited)--> 
    </Item>                              
  </Result>                              
  <Message>string</Message>              <!--Error message--> 
</Response>                              
{                              
   "Result": [{                
      "ID": "string",          // Unique folder ID
      "FolderPath": "string"   // Path name (backslash-delimited)
   }],                         
   "Message": "string"         // Error message
}

Status Codes

Code Condition
200 OK The operation completed successfully.
400 Bad RequestInvalid file ID.
401 Unauthorized Access token is invalid, expired or not specified.
403 ForbiddenUser does not have permission to list documents on the file.
404 Not FoundFile not found.
406 Not Acceptable Content type specified in the Accept header isn't supported.
500 Internal Server Error An internal error occurred.