Get All Project

You can fetch all projects from here

/api/Project

Query String

Parameter	Required	Value
orderBy	Mandatory	0 (Asc) or 1 (Desc)
start	Mandatory	blank
*userLicenseType	Optional	Enum
*isFavorite	Optional	Enum
*responseStatus	Optional	Enum
accountId	Optional	User Input
isCabinet	Optional	Enum
isArchived	Optional	Enum
isHostCollab	Optional	Enum
includeArchive	Optional	Enum

Request Header

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

Response

[
  {
    "PINProjectID": 12152,
    "ProjectNumber": "PN/12/05/002",
    "ProjectName": "Siddha Town",
    "ProjectStartDate": "2012-05-28T12:18:00",
    "ProjectOwner": {
      "PWUserID": 12249,
      "PWAccountID": 12207,
      "PWContactID": 121455,
      "FirstName": "Ayan",
      "MiddleName": "",
      "LastName": "Ghosh",
      "Email": "[email protected]",
      "UserName": "Ayan Ghosh"
    },
    "ResponseStatus": 2,
    "UserLicenseType": 2,
    "IsFavorite": 0,
    "EnableNotifyOnDownload": true,
    "IsArchived": false,
    "IsCabinet": false 
  }
]

Content–Range   
Previous–Page
Next–Page
Max–Page
Accept–Ranges   Page
UserLicenseType-Contact 0
UserLicenseType-Free%20user 1
UserLicenseType-Hosting%20user  2
UserLicenseType-Collaborative%20user    3
UserLicenseType-Lite%20user 4

Enum : UserLicenseType

Property Name	Description
0 – Contact	Contact
1 – FreeUser	Free User
2 – HostingUser	Employee
3 – CollaborativeUser	Shared User
4 – LiteUser	Lite User

Enum : IsFavorite

Property Name	Description
0 – Normal	Normal Projects
1 – Favorite	Favorite Projects

Enum : ResponseStatus

Property Name	Description
1 – NotAtResponded	Not responded
2 – Accepted	Accepted
3 – Denied	Denied
4 – OptoutforfurterNotification	Optout for further notification

Enum : IsCabinet

Property Name	Description
0 – Normal	Normal Projects
1 – Workspace	Workspace Projects

Enum : IsArchived

Property Name	Description
0 – Normal	Normal Projects
1 – Archived	Archived Projects

Enum : IsHostCollab

Property Name	Description
0 – No	All Projects
1 – Yes	Only Host And Collaborative Projects

Enum : IncludeArchive

Property Name	Description
0 – No	Only Active Projects
1 – Yes	Active And Archived Projects

Enum : OrderBy

Property Name	Description
0 – ProjectName	Project Name Ascending
1 – ProjectNameDesc	Project Name Descending
2 – ProjectNumber	Project Number Ascending
3 – ProjectNumberDesc	Project Nmuber Descending

User Entity

Property Name	Description
PWUserID	Integer
PWAccountID	Integer
PWContactID	Integer
FirstName	String
MiddleName	String
LastName	String
Email	String
UserName	String

Project Entity

Property Name	Description
PINProjectID	Integer
ProjectNumber	String
ProjectName	String
ProjectStartDate	DateTime
ProjectOwner	User
ResponseStatus	Integer
UserLicenseType	Integer
IsFavorite	Integer [Nullable]
EnableNotifyOnDownload	Boolean
IsArchived	Boolean
IsCabinet	Boolean
DocumentCount	Integer [Nullable]

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.
Use header parameter PageForId only for getting the data of that particular page in which that Project is belonging (with the same filtration logic).
If request header contains PageForId then it will get the first preference for populating project list.
Response header parameter Accept–Ranges will not come with paginated data and other response header parameters will not come for all records population.
Response header parameters UserLicenseType-Contact, UserLicenseType-Free%20user, UserLicenseType-Hosting%20user, UserLicenseType-Collaborative%20user and UserLicenseType-Lite%20user will dynamically arise based on the response content generated and indicate that the requested user has how many different UserLicenseType (access permission).
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 active projects do not add userLicenseType, isFavorite, isCabinet, isArchived, isHostCollab and includeArchive in query string.
Add start in query string only for filtering project by ProjectName.
Add orderBy in query string only for changing the default sorting order of the resulted list. Default sorting is by ProjectName.
Add accountId in query string only for getting account specific projects.
If value of request header parameter FetchItemsCount is ‘True’ then DocumentCount and FolderCount will be added to the list items which specifies the current total count of the folder and document respectively of that project (count will not consider user specific permissions on the folder and document)