Zoho Projects API for Developers

Milestones API for Developers

How to Add Milestones ?

Method Name :

https://projectsapi.zoho.com/portal/{PortalName}/api/private/xml/project/add

API Description :

Given authtoken, projecttitle, project description creates a new Project on successful authentication.

Parameters to be passed :

authtoken, mtitle, mstartdate, msdate, owner, projid, flag, status

Sample Call

<form method="post" action="https://projectsapi.zoho.com/portal/{PortalName}/api/private/xml/ms/add?authtoken=[AuthToken]">
Milestone Title <input type="hidden" name="mtitle" value="Accounts">
Startdate<input name="mstartdate" type="hidden" value='07-15-2009'> (date format MM-dd-yyyy)
Enddate <input name="msdate" type="hidden" value='08-17-2009'>(date format MM-dd-yyyy)
TaskOwner:<input type="hidden" name="owner" value="">(loginid/userid)
ProjId<input type="hidden" name="projId" value="">
Flag<input type="hidden" name="flag" value="internal">
Status<input type="hidden" name="status" value="">(completed | notcompleted)
<input type="submit" value="Add New Milestone" >
</form>

Output XML

<response>
   <uri>/api/private/xml/ms/add</uri>
   <result>
   <MilestoneDetails>
   <MilestoneDetail>
   <MS_id>iU2Ms4923frek0A2+Ki37g==</MS_id>
   <MS_name> Accounts</MS_name>
   <MS_startdate>2009-07-15 00:00 </MS_startdate>
   <MS_duedate>2009-08-17 23:59:</MS_duedate>
   <MS_Status>notcompleted</MS_Status>
   <MS_Priority>None</MS_Priority>
   </MilestoneDetail>
   </MilestoneDetails>
   </result>
</response>

Output JSON

{response:{uri:'/api/private/json/ms/add',result:{milestonedetails:{msdetail:{ms_id:'iU2Ms4923frek0A2+Ki37g==',
ms_name:'Accounts',ms_startdate:2009-07-15 00:00,ms_duedate:2009-08-17 23:59,
ms_status:'notcompleted',ms_priority:'None'}}}}}

How to Get All Milestones ?

Method Name :

https://projectsapi.zoho.com/portal/{PortalName}/api/private/xml/mss

API Description :

Given authtoken gets all the milestones on sucessful authentication.

Parameters to be passed :

authtoken, projid, status, matchcrit, flag

Sample Call

<form method="post" action="https://projectsapi.zoho.com/portal/{PortalName}/api/private/xml/mss?authtoken=[AuthToken]">
<input type="hidden" name="projId" value="">
<input type="hidden" name="flag" value="internal">(or external or allflag or internal)
<input type="hidden" name="status" value="notcompleted">(or completed)
<input type="hidden" name="matchcrit" value="upcoming">( or delayed)
<input type="submit" value="Get Milestones">
</form>

Output XML

<response>
   <uri>/api/private/xml/mss</uri>
   <result>
   <MilestoneDetails>
   <MilestoneDetail>
   <MS_id>iU2Ms49a5vree0A2+Ki37g==</MS_id>
   <MS_name>Accounts</MS_name>
   <MS_startdate>2009-07-15 00:00</MS_startdate>
   <MS_duedate>2009-08-17 23:59</MS_duedate>
   <MS_CompletedOn>2009-08-17 23:59</MS_CompletedOn>
   <MS_Status>completed</MS_Status>
   <MS_Priority>None</MS_Priority>
   </MilestoneDetail>
   </MilestoneDetails>
   </result>
</response>

Output JSON

{response:{uri:'/api/private/json/mss',result:{milestonedetails:{msdetail:{ms_id:'iU2Ms49a5vree0A2+Ki37g==',ms_name:'Accounts',ms_startdate:'2009-07-15 00:00',ms_duedate:2009-08-17 23:59,ms_completedon:'2009-08-17 23:59',ms_status:'completed',ms_priority:'None'}}}}}

How to Update Milestone ?

Method Name :

https://projectsapi.zoho.com/portal/{PortalName}/api/private/xml/ms/update

API Description :

Given authtoken and one of the milestoneId, returns the updated milestone on sucessful authentication.

Parameters to be passed :

authtoken, milestonetitle, startdate, enddate, owner, projid, flag, status

Sample Call

<form method="post" action="https://projectsapi.zoho.com/portal[yourportalname]/api/private/xml/ms/update?authtoken=[AuthToken]">
Milestone title :<input type="text" name="mtitle" value="Accounts - August">
Startdate: <input name="mstartdate" type="text" value="">(date format MM-dd-yyyy)
Enddate <input name="msdate" type="text" value="">(date format MM-dd-yyyy)
TaskOwner: <input type="text" name="owner" value="">(loginId/userid)
ProjId:<input type="text" name="projId" value="">
MileStoneId:<input type="text" name="mid" value="iU2Ms49a5vree0A2+Ki37g==">
Flag:<input type="text" name="flag" value="internal">(or external)
<input type="submit" value="Update Milestone">
</form>

Output XML

<response>
   <uri>/api/private/xml/ms/update</uri>
   <result>
   <MilestoneDetails>
   <MilestoneDetail>
   <MS_id>iU2Ms49a5vree0A2+Ki37g==</MS_id>
   <MS_name>Accounts - August</MS_name>
   <MS_startdate>2009-08-18 00:00</MS_startdate>
   <MS_duedate>2009-08-21 23:59</MS_duedate>
   <MS_CompletedOn>2009-08-21 23:59</MS_CompletedOn>
   <MS_Status>notcompleted</MS_Status>
   <MS_Priority>None</MS_Priority>
   </MilestoneDetail>
   </MilestoneDetails>
   </result>
</response>

Output JSON

{response:{uri:'/api/private/json/ms/update',result:{milestonedetails:{msdetail:{ms_id:'iU2Ms49a5vree0A2+Ki37g==',
ms_name:'Accounts-August',ms_startdate:2009-08-18 00:00,ms_duedate:'2009-08-21 23:59',
ms_completedon:2009-08-21 23:59,ms_status:'notcompleted',ms_priority:'None'}}}}}

How to Mark a Milestone Completed ?

Method Name :

https://projectsapi.zoho.com/portal/{PortalName}/api/private/xml/ms/setstatus

API Description :

Given the authtoken, milestoneId and isCompleted as 2 or 1, marks the milestone as completed or incomplete on successful authentication.

Parameters to be passed :

authtoken, isCompleted (either 1 or 2)

Sample Call

<form method="post" action="https://projectsapi.zoho.com/portal/{PortalName}/api/private/xml/ms/setstatus?authtoken=[AuthToken]">
<input type="hidden" name="mid" value="">
<input type="hidden" name="status" value="1"> (2-completed,1-notcompleted)
<input type="submit" value="Change Milestone Status">
</form>

Output XML

<response>
   <uri>/api/private/xml/ms/setstatus</uri>
   <result>
   <MilestoneDetails>
   <MilestoneDetail>
   <MS_id>iU2Ms49a5vree0A2+Ki37g==</MS_id>
   <MS_name>Accounts - August</MS_name>
   <MS_startdate>2009-08-18 00:00</MS_startdate>
   <MS_duedate> >2009-08-20 23:59</MS_duedate>
   <MS_CompletedOn> >2009-08-21 12:55</MS_CompletedOn>
   <MS_Status>completed</MS_Status>
   <MS_Priority>None</MS_Priority>
   </MilestoneDetail>
   </MilestoneDetails>
   </result>
</response>

Output JSON

{response:{uri:'/api/private/json/ms/setstatus',result:{milestonedetails:{msdetail:{ms_id:'iU2Ms49a5vree0A2+Ki37g==',ms_name:'Accounts-August',ms_startdate:'2009-08-18 00:00',ms_duedate:'2009-08-20 23:59',ms_completedon:'2009-08-21 12:55:00.0',ms_status:'completed',ms_priority:'None'}}}}}

How to Delete a Milestone ?

Method Name :

https://projectsapi.zoho.com/portal/{PortalName}/api/private/xml/ms/delete

API Description :

Given authtoken and milestoneId, deletes the specified milestone on successful authentication.

Parameters to be passed :

authtoken, milestoneId

Sample Call

<form method="post" action="https://projectsapi.zoho.com/portal/{PortalName}/api/private/xml/ms/delete?authtoken=[AuthToken]">
MileStoneId<input type="text" name="mid" value="">
ProjectId<input type="text" name="projId" value="">
<input type="submit" value="Delete milestone">
</form>

Output XML

<result>Deleted Successfully</result>

Output JSON

{result:'Deleted Successfully'}

Top