Get Project Document

You will get project documents from here

/api/ProjectDocument/GetProjectDocuments

Query String

Parameter	Required	Value
start	Optional	1
orderBy	Optional	User Input
isPublished	Optional	User Input
SortBy	Optional	Name
SortOrder	Optional	0(Ascending) and 1(Descending)
pinProjectId	Optional
source	Optional
parentFolderId	Optional
startWith	Optional
sessionId	Optional
sessionId	Optional

Request Header

Parameter	Required	Value
TokenKey	Mandatory	User Input
IgnorePermission	Optional	True/False
FromAws	Optional	True/False
Accept-Language	Optional	en-US
Accept-Encoding	Optional	gzip
Content-Type	Mandatory	application/json

Response

TokenKey → Your-Key

[
  {
    "ProjectFolderID": 122260,
    "PINProjectID": 12148,
    "ProjectDocumentID": 1219685,
    "CurrentCheckOutStatus": 2,
    "DocumentTitle": "",
    "DocumentDesc": "",
    "DocumentName": "CDEF.DWF",
    "SearchTag": "",
    "OriginalFileName": "d778f3ef-b026-4bd2-a9e3-258e37f184e0",
    "OriginalExtension": ".DWF",
    "Filesize": "76684",
    "UploadStatus": 2,
    "RevisionDate": "2012-10-11T13:22:20.737",
    "RevisionNumber": 1,
    "RevisedBy": {
      "PWUserID": 12249,
      "PWAccountID": 12207,
      "PWContactID": 121455,
      "FirstName": "Ayan",
      "MiddleName": "",
      "LastName": "Ghosh",
      "Email": "[email protected]",
      "UserName": "Ayan Ghosh"
    },
    "CheckedBy": {
      "PWUserID": 12301,
      "PWAccountID": 12254,
      "PWContactID": 121541,
      "FirstName": "Srabati",
      "MiddleName": "",
      "LastName": "Sarkar",
      "Email": "[email protected]",
      "UserName": "Srabati Sarkar"
    },
    "IsMarkupExists": false,
    "Permission": {
      "Read": true,
      "Download": true,
      "Upload": false,
      "Modify": true,
      "Delete": true,
      "CheckOut": true,
      "ChangeTask": false
    },
    "Download": <DownloadUrl>,
    "AWSDownload": <AWSDownloadUrl>,
    "View": <ViewerUrl>,
    "StorageID": 100001
  }
]

Enum : Source

Property Name	Description
2 – HPPrinter	Upload From HP Printer
4 – TurboAccelerator	Upload From Turbo Accelerator
5 – Html5Uploader	Upload From Html 5 Uploader
16 – IPhone	Upload From iOS Device
32 – Andriod	Upload From Android Device
128 – WinSync	Upload From Windows Sync
129 – MacSync	Upload From Mac Sync
130 – PSIGEN	Upload From PSIGEN App

Enum : StartWith

Property Name	Description
0 – No	Contain Search
1 – Yes	Search by Starting Letter

Enum : OrderBy

Property Name	Description
0 – CreateDate	Create Date Ascending
1 – CreateDateDesc	Create Date Descending
2 – DocumentName	Document Name Ascending
3 – DocumentNameDesc	Document Name Descending

Enum : Permission

Property Name	Description
0 – No	Do not Fetch Permission Set
1 – Yes	Fetch Permission Set

Enum : CurrentCheckOutStatus

Property Name	Description
1 – CheckedIn	Checked In
2 – CheckedOut	Checked Out

Entity : Project Document

Property Name	Data Type
ProjectFolderID	Integer
PINProjectID	Integer
ProjectDocumentID	Integer
CurrentCheckOutStatus	Integer
DocumentTitle	String
DocumentDesc	String
DocumentName	String
SearchTag	String
OriginalFileName	String
OriginalExtension	String
Filesize	String
UploadStatus	Byte [Nullable]
RevisionDate	DateTime [Nullable]
RevisionNumber	Integer [Nullable]
RevisionRemarks	String
RevisedBy	User
ExpiryDate	DateTime [Nullable]
ShareLink	String
IsMarkupExists	Boolean
MarkupCount	Integer [Nullable]
PathName	String
PathFolderID	String
Permission	Permission
Download	String
AWSDownload	String
View	String
StorageID	Integer
CustomProperties	IEnumerable

Remarks

For getting all records at a time do not add Page in request header.
Use PerPage parameter to change maximum number of records per page during population of paginated data; by default, each page contains at most 10 records at a time.
Add FromAWS in request header only for getting aws download url.
Response header parameter Accept–Ranges will not come with paginated data and other response header parameters will not come for all records population.
If the paginated result is empty, then response header parameter Max–Page will be 0 (zero) and there will be no other page related response header parameter.
For getting all project related document do not add parentFolderId in query string.
Add start in query string only for filtering project document by DocumentName.
Add startWith in query string only for changing search criteria.
Add orderBy in query string only for changing the default sorting order of the resulted list. Default sorting is by CreateDateDesc.
Add permission in query string only for having Permission in response content.
sessionId is optional in query string but it is mandatory when request is coming from TurboAccelerator (Source is 4).
Filesize is in bytes.
MarkupCount will not appear when IsMarkupExists is false.
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 document.
Download, AWSDownload and View in response content will contain normal download url, aws download url and viewer url respectively only when the logged in user has download permission. As well as AWSDownload will not be appear if request header does not contain FromAWS key with appropriate value or document is not present in aws.
View in response body will only available for IPhone (Source is 16) and Android (Source is 32).
For WinSync (Source is 128) and MacSync (Source is 129), one particular download url will be valid for downloading the document for maximum 3 (three) attempts and for others it will be invalid after first attempt.
If Read is true then logged in user has permission to View the meta–information of that document, if Download is true then logged in user has permission to Download and create ShareLink of that document, if Modify is true then logged in user has permission to Update file information, if Delete is true then logged in user has permission to Delete that file, if CheckOut permission is true then logged in user has permission to CheckOut that file.
Upload and ChangeTask inside Permission in response body is not related to document permission.