Projects

Track/APIs/Projects.md

@@ -4,6 +4,7 @@
 
 Stable.
 
+
 ## GET /projects
 
 Returns the list of projects accessible by the user
@@ -58,11 +59,46 @@ Creates a new project
 * 406 Duplicated
 
 ### Example
-POST `https://track.timeneye.com/api/3/projects`
+GET `https://track.timeneye.com/api/3/projects/1245`
 Post Data: name=My+Test+Project
 
 API returns:
 
     {
-        "projectId":1014
+        "id":1014
+    }
+
+
+## GET /projects/[ID]/
+
+Returns project's details. Some details are shown only to PMs and admins.
+
+### Returns
+* HTTP Code: 200 OK
+* id (int)
+* name (string)
+* isActive (tinyint)
+* clientId (int, PMs only)
+* clientName (int, PMs only)
+* hourlyRate (int, PMs only)
+* budgetMinutes (int, PMs only)
+
+### Errors
+* 400 Bad Request: missing required parameters
+* 401 Unauthorized: authToken not valid
+
+### Example
+GET `https://track.timeneye.com/api/3/projects/1323`
+
+API returns:
+
+    {
+        "id":"1014",
+        "name":"Ciccio Pasticcio2",
+        "isActive":"1",
+        "clientId":"-1",
+        "clientName":"",
+        "isBillable":"0",
+        "hourlyRate":"0.00",
+        "budgetMinutes":"0"
     }