Get Project Folders List

You will get project folders from here

/api/ProjectFolder/GetList

Query String

ParameterRequiredValue
pinProjectIdMandatory
parentFolderIdOptional
startOptionalUser Input
SortByOptionalName
SortOrderOptional0(Ascending) and 1(Descending)
permissionOptional

Request Header

ParameterRequiredValue
TokenKeyMandatoryUser Input
Accept-LanguageOptionalen-US
Accept-EncodingOptionalgzip
Content-TypeMandatoryapplication/json
PINProjectIDOptionalUser Input

Response

TokenKey → Your-Key
[
  {
    "ProjectFolderID": 132895,
    "FolderName": "Project Specification",
    "ParentFolderID": 0,
    "LevelID": 0,
    "CreatedBy": {
      "PWUserID": 12249,
      "PWAccountID": 12207,
      "PWContactID": 121455,
      "FirstName": "Ayan",
      "MiddleName": "",
      "LastName": "Ghosh",
      "Email": "[email protected]",
      "UserName": "Ayan Ghosh"
    },
    "CreateDate": "2013-07-15T12:54:34.06",
    "ChildFolderCount": 2,
    "DocumentCount": 7,
    "PINProjectID": 12148,
    "PathName": "Project Specification",
    "PathFolderID": ">132895>",
    "Permission": {
      "Read": true,
      "Download": true,
      "Upload": true,
      "Modify": true,
      "Delete": false,
      "CheckOut": false,
      "ChangeTask": false
    }
  }
]

Enum : PermissionSet

Property NameDescription
0 – NoDo not Fetch Permission Set
1 – YesFetch Permission Set

Enum : Permission

Property NameDescription
1 – ReadFolderRead Folder
2 – DownloadFilesDownload Files
4 – UploadFilesUpload Files
8 – ChangeFolderChange Folder

Entity : Project Folder

Property NameData Type
ProjectFolderIDInteger
FolderNameString
ParentFolderIDInteger [Nullable]
LevelIDInteger
CreatedByUser
CreateDateDateTime
ChildFolderCountInteger
DocumentCountInteger
PINProjectIDInteger
ExpiryDateDateTime [Nullable]
PathNameString
PathFolderIDString
IsNewBoolean [Nullable]
PermissionPermission
ChildFoldersIEnumerable< ProjectFolder>
ErrorInfoErrorInfo

Remarks

  1. Response header parameter Permission will contain folder permission code.

  2. Permission in response body will only come when the value of query string parameter permission is 1 & it holds the permission for logged in user on that folder.

  3. If Read is true then logged in user has permission to View the meta–information of that folder, if Download is true then logged in user has permission to create ShareLink of that folder, if Upload is true then logged in user has permission to Upload file inside the folder, if Modify is true then logged in user has permission to Create sub–folder under that folder, Update folder information and Delete that folder.

  4. Delete, CheckOut and ChangeTask inside Permission in response body is not related to folder permission.