Folder resource

Get folder info - Get folder info v2

OVERVIEW

This is the second version of this API which was changed in Collaborate 4.1.4 and above

The method provides folder detail given the folder id.
 

Resource(API) EndPoint Query Params HTTP Method Request XML Response XML Response Code
/folders/{folderid}   GET   Response XML Response Code

 

Response XML:

<folder>
<id>3074</id>
<name>Root</name>
<permission>
            <view>1</view>
            <edit>1</edit>
            <delete>0</delete>
            <addEditAllFiles>1</addEditAllFiles>                                            <!-- ( Permission Element in API version 2 (supported from 4.0.3 branch))  -->
            <viewAllFiles>1</viewAllFiles>
            <admin>1</admin>
 </permission>        
<siteid>1</siteid>  (this attribute supported from 3.4.3)

<parentFolderID>9</parentFolderID>
<accessInherited>1</accessInherited>              <!-- (supported from 4.0.3 branch)  -->

<description>file 1 description</description>

<createddate>20 May 2014 10:12</createddate>

<modifieddate>12 Jun 2014 12:02</modifieddate>
<location>Deleted Items</location>                      <!-- (supported from 3.4.4 branch)  -->

<dms>
             <dmsfolderid>1001</dmsfolderid>
 
            <dmsParentFolderID>0</dmsParentFolderID>

           <dmscreateddate>1400580752</dmscreateddate> <!--- (unix epoch value) ---> 

           <dmsmodifiedBy>103</dmsmodifiedBy>

            <dmsdatabasename>username</dmsdatabasename>
</dms>
 
<createdby>
        <firstname>first</firstname>
        <lastname>last</lastname>
        <email>first.last@highq.com</email>
        <userid>103</userid>
 </createdby>

 <modifiedby>
        <firstname>first</firstname>
        <lastname>last</lastname>
        <email>first.last@highq.com</email>
        <userid>103</userid>
 </modifiedby>

</folder>

 

Notes: 

Please note that the permissions element in the response body has been introduced in Collaborate 4.0.3. The permissions element provides the callers permissions for that folder. 

A value of 1 means that the user has that specific permission e.g "view" and a value of 0 means that the user does not have the specific permission for the folder. The permission names are inline with the folder permissions as configured through the site admin interface. The addEditAllFiles and viewAllFiles relate to files in the folder where as the rest of the permission relate to the folder itself. 

"accessInherited"  field indicates if the folder has inherited the permissions from its parent folder or not. 

 

Response Code:

Following HTTP code will be returned to the calling client:
 

Code Meaning
401 Unauthorized
403 Validation failed/ Forbidden
405 Method not allowed (calling api with wrong method)
500 Internal error occurred

 

Comments


1 Comments

Last Updated: Nov 08,2024