Version 1.1
/Mobile/projects/get
Inputs
Input | Input Definition | Required | Detailed Description |
pid | Retrieve a single project instead of an array of projects | No | optional if you just want to get a single project |
status | Retrieve my projects that are closed (0) or open (1) | No | pass 0 for closed/completed projects, and 1 for currently open projects. Not passing this parameter will get both. |
type | used to determine JSON or XML | No | If parameter is not passed than it will assume JSON. |
sid | The user's session id | Yes | If you do not pass a user session then no action can be taken. See the session debug section for disabling the session for debuging. |
While you can pass sid as GET parameter you are also welcome and recommended to pass it via POST for more security.
Ouputs
Response | Response Definition | Detailed Description |
statusCode | The status code for the returned result. (In this case should always be Success | |
statusMessage | The message that describes the associated status code. | |
projectCount | The number of projects returned | |
projects | start of the array of projects | |
name | The name of the project | |
desc | The description of the project | |
start | The start date of the project in epoch time | |
end | The end date of the project in epoch time. | |
daysleft | The number of days remaining | |
done | The percent done with the project. | |
Sample Outputs
JSON
{"response":
{"status":
{"statusCode":1,
"statusMessage":"Success!"},
"projectCount":16,
"projects":
[{"name":"Test project",
"desc":"Sweet Awesome project Again",
"start":"1315453683",
"end":"",
"daysleft":" ",
"done":0},
{"name":"Collab Mobile API",
"desc":"",
"start":"1315453696",
"end":"1333173600",
"daysleft":39,
"done":0}]
}
}
XML
<?xml version="1.0" encoding="UTF-8"?>
<response>
<status>
<statusCode>2</statusCode>
<statusMessage>Success!</statusMessage>
</status>
<projectCount>2</projectCount>
<projects>
<project>
<name>Test project</name>
<desc>Sweet Awesome project Again</desc>
<start>1315453683</start>
<end/>
<daysleft> </daysleft>
<done>0</done>
</project>
<project>
<name>Collab Mobile API</name>
<desc/>
<start>1315453696</start>
<end>1333173600</end>
<daysleft>39</daysleft>
<done>0</done>
</project>
</projects>
</response>