Version 1.1

/Mobile/projects/milestones/get

Inputs

Input Input Definition Required Detailed Description
pid Retrieve milestones for project id No If not passed, it will return all milestones for user for all projects.
mid Retrieve a singluar milestone No When passed it ignores pid, and status.
status Return only status of this type (0,1) No If not passed, it will return all statuses.
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.
MilestoneCount The number of projects returned
Milestones start of the array of milestones
id The id of the milestone
pid The id of the associated project
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.
status the status of the milestone (1) Active/Open, (0) InActive/Closed


Sample Outputs

JSON

{"response":
  {"status":
    {"statusCode":2,
     "statusMessage":"Success!"},
   "milestoneCount":16,
   "milestones":
   [{"id":"66",
     "pid":"28",
     "name":"test",
     "desc":"",
     "start":"1329412365",
     "end":"1329375600",
     "status":"1"}]
  }
}

XML

<?xml version="1.0" encoding="UTF-8"?>
<response>
  <status>
    <statusCode>2</statusCode>
    <statusMessage>Success!</statusMessage>
  </status>
  <milestoneCount>16</projectCount>
  <Milestones>
    <id>66</id>
    <pid>28</pid>
    <name>test</name>
    <desc/>
    <start>1329412365</start>
    <end>1329375600</end>
    <status>1</status>
  </projects>
</response>

Last edited Feb 24, 2012 at 9:01 PM by darxval, version 4

Comments

No comments yet.