|
Home
Get Ticket
Get API Key
API Reference
Projects
Dashboard
Milestones
Tasklists
Meetings
Documents
Timesheet
Forums
Users
Error Codes
|
Projects API
|
|
How to Get User Portals ?
|
|
Method Name :
http://projects.zoho.com/api/private/xml/dashbs/getportals
API Description :
Given the ticket, apikey returns the portals of the user.
Parameters to be passed :
ticket, apikey
|
| Sample Call |
<form method="post"
action="http://projects.zoho.com/api/private/xml/dashbs/getportals?apikey=[ApiKey]&ticket=[ticket]">
<input type="submit" value="Get Portals" >
</form> |
| Output XML |
<response>
<uri>/api/private/xml/dashbs/getportals</uri>
<result>
<PortalDetails><login_id>eWXkpSeN4PA=</login_id>
<PortalName>
<portal>zillum</portal>
</PortalName>
</PortalDetails>
</result>
</response> |
| Output JSON |
{ response:{ uri:'/api/private/xml/dashbs/getportals',result:{portaldetails:{login_id:'eWXkpSeN4PA=',portalname:{portal:'zillum'}}}}}
|
How to Get User Login Id ?
|
|
Method Name :
http://projects.zoho.com/portal/{PortalName}/api/private/xml/dashbs/getlogin
API Description :
Given the ticket, apikey returns the current userId
Parameters to be passed :
ticket, apikey
|
| Sample Call |
<form method="post"
action="http://projects.zoho.com/api/private/xml/dashbs/getlogin?apikey=[ApiKey]&ticket=[ticket]">
<input type="submit" value="Get current userid">
</form> |
| Output XML |
<response>
<uri>/api/private/xml/dashbs/getlogin</uri>
<result>
<login_id>eWXkpSeN4PA=</login_id>
</result>
</response> |
| Output JSON |
{response:{uri:'/api/private/xml/dashbs/getlogin',result:{login_id:'eWXkpSeN4PA='}}}
|
How to Get User Photo URL ?
|
|
Method Name :
http://projects.zoho.com/portal/{PortalName}/api/private/xml/user/getphotourl
API Description :
Given the ticket, apikey ,userId returns the photo url
Parameters to be passed :
ticket, apikey,userId
|
| Sample Call |
<form method="post"
action="http://projects.zoho.com/api/private/xml/user/getphotourl?apikey=[ApiKey]&ticket=[ticket]">
<input type="text" value="" name="userId">
<input type="submit" value="Get photo url" >
</form> |
| Output XML |
<response>
<uri>/api/private/xml/user/getphotourl</uri>
<result>
<user_photo>
http://projects.zoho.com/portal/{portalname}/dloadphoto?uid=6JfpOy0MHtQtAb%2BtcjsSobLLhOlKWZDY
</user_photo>
</result>
</response> |
| Output JSON |
{response:{uri:'/api/private/xml/user/getphotourl',result:{user_photo:'http://projects.zoho.com/portal/{portalname}dloadphoto?uid=6JfpOy0MHtQtAb%2BtcjsSobLLhOlKWZDY'}}}
|
How to Get All Projects ?
|
|
Method Name :
http://projects.zoho.com/portal/PortalName/api/private/xml/projects
API Description :
Given the ticket and apikey, returns the list of all
projects in zoho planner on successful authentication.
Parameters to be passed :
ticket, apikey
|
| Sample Call |
<form method="post" action="http://projects.zoho.com/portal/{PortalName}/api/private/xml/projects?apikey=[ApiKey]&ticket=[ticket]">
<input type="text" name="auditIndex" value="1"/>
<input type="text" name="range" value="6"/>
<input type="submit" value="Get All Projects" >
</form> |
| Output XML |
<response>
<uri>/api/private/xml/projects</uri>
| - |
<result>
<ProjectDetails>
| - |
<ProjectDetail>
<project_id>iU2Ms49a5vxMGj8WzHZqjQ==</project_id>
<project_name>ERP Phase 1</project_name>
<project_status>active</project_status>
<proj_created>2009-10-20 17:08</proj_created>
</ProjectDetail> |
| - |
<ProjectDetail>
<project_id>iU2Ms49a5vywk0A2+Ki37g==</project_id>
<project_name>ERP Phase 2</project_name>
<project_status>active</project_status>
<proj_created>2009-08-15 13:26</proj_created>
</ProjectDetail> |
</ProjectDetails> |
|
</result> |
</response> |
| Output JSON |
{response:{ uri:'/api/private/xml/projects',result:{projectdetails:{projectdetail:[{project_id:'iU2Ms49a5vxMGj8WzHZqjQ==',project_name:'ERP Phase 1',project_status:'active',proj_created:2009-10-20 17:08},{project_id:'iU2Ms49a5vywk0A2+Ki37g==',project_name:'ERP Phase 2',project_status:'active',proj_created:2009-08-15 13:26}]}}}}
|
How to Get Project Details ?
|
|
Method Name :
http://projects.zoho.com/portal/{PortalName}/api/private/xml/project/content
API Description :
Given ticket, apikey and projectId from the list of projects
got from the above api, returns the details of the project on successful authentication.
Parameters to be passed :
ticket, apikey and projectId
|
| Sample Call |
<form
method="post"
action="http://projects.zoho.com/portal/{PortalName}/api/private/xml/project/content?apikey=[ApiKey]&ticket=[ticket]">
<input type="text" value="iU2Ms49a5vywk0A2+Ki37g==" name="projId">
<input type="submit" value="Get Project Content">
</form> |
| Output XML |
<response>
<uri>/api/private/xml/project/content</uri>
| - |
<result>
<ProjectDetails>
| - |
<ProjectDetail>
<project_id>iU2Ms49a5vywk0A2+Ki37g== </project_id>
<project_name>ERP Phase 3</project_name>
<project_status>archived</project_status>
<proj_type>public</proj_type>
</ProjectDetail> |
</ProjectDetails> |
|
</result> |
</response> |
| Output JSON |
{response:{uri:'/api/private/xml/projectcontent',result:projectdetails:projectdetail:project_id:'iU2Ms49a5vywk0A2+Ki37g==,project_name:'ERP Phase3',project_status:'archived',proj_type:'public'}}}}}
|
How to Create a New Project ?
|
|
Method Name :
http://projects.zoho.com/portal/{PortalName}/api/private/xml/project/add
API Description :
Given ticket, apikey, projecttitle,project description creates a new Project on successful authentication.
Parameters to be passed :
ticket, apikey, project title,Project description
|
| Sample Call |
<form
method="post"
action="http://projects.zoho.com/portal/{PortalName}/api/private/xml/project/add?apikey=[ApiKey]&ticket=[ticket]">
<input type="hidden" name="projTitle" value="Finance Module - July to October">
<input type="hidden" name="projDesc" value="Financial details for the month of July, August, September and October.">
<input type="submit" value="Add New Project">
</form> |
| Output XML |
<response>
<uri>/api/private/xml/project/add</uri>
| - |
<result>
<ProjectDetails>
| - |
<ProjectDetail>
<project_id>iU2Ms49a5vywk0A2+Ki37g==</project_id>
<project_name>Finance Module - July to October</project_name>
<project_status>active</project_status>
<proj_desc>Financial details for the month of July, August, September and October.</proj_desc>
</ProjectDetail> |
</ProjectDetails> |
|
</result> |
</response> |
| Output JSON |
{response:{uri:'/api/private/xml/project/add',result:{projectdetails:{projectdetail:{project_id:'iU2Ms49a5vywk0A2+Ki37g==',project_name:'Finance Module - July to October',project_status:'active',proj_desc:'Financial details for the month of July, August, September and October.'}}}}}
|
How to Delete a Project ?
|
|
Method Name :
http://projects.zoho.com/portal/{PortalName}/api/private/xml/project/delete
API Description :
Given ticket, apikey and ProjId, deletes the specified
project on successful authentication.
Parameters to be passed :
ticket, apikey,projid
|
| Sample Call |
<form method="post"
action="http://projects.zoho.com/portal/{PortalName}/api/private/xml/project/delete?ticket=[Ticket]&apikey=[ApiKey]">
<input type="text" value="iU2Ms49a5vywk0A2+Ki37g==" name="projId">
<input type="submit" value="Delete Project">
</form> |
| Output XML |
| <result>Project deleted Successfully</result> |
| Output JSON |
{result:'Project deleted Successfully'}
|
How to Update a Project ?
|
|
Method Name :
http://projects.zoho.com/portal/{PortalName}/api/private/xml/project/update
API Description :
Given the ticket, apikey, project id returns the updated project on successful authentication.
Parameters to be passed :
ticket, apikey ,projid
|
| Sample Call |
<form method="post"
action="http://projects.zoho.com/portal/{PortalName}/api/private/xml/project/update?apikey=[ApiKey]&ticket=[ticket]">
<input type="hidden" name="projId" value="iU2Ms49a5vywk0A2+Ki37g==">
<input type="hidden" name="projTitle" value="Revised Finance Module">
<input type="hidden" name="projDesc" value="Project has been updated with additional details for the month of August & September">
<input type="hidden" name="status" value="active"> (The two values for the status should be either active or archived)
<input type="submit" value="Update Project">
</form> |
| Output XML |
<response>
<uri>/api/private/xml/project/update</uri>
| - |
<result>
<ProjectDetails>
| - |
<ProjectDetail>
<project_id>iU2Ms49a5vywk0A2+Ki37g==</project_id>
<project_name>Revised Finance Module</project_name>
<project_status>active</project_status>
<proj_desc>Project has been updated with additional details for the month of August & September </proj_desc>
</ProjectDetail> |
</ProjectDetails> |
|
</result> |
</response> |
| Output JSON |
{response:{uri:'/api/private/xml/project/update',result:{projectdetails:{projectdetail:{project_id:'iU2Ms49a5vywk0A2+Ki37g==',project_name:'Finance Module',project_status:'active',proj_desc:'Project has been updated with additional details for the month of August & September"'}}}}}
|
|
" Wow! New 'social' layout for @zoho projects - even has a search - so far so good! Thanks Zoho Team! " - officeassist