Home  »  Zoho Projects - Forums API

Zoho Projects - Forums API

Tags:  

Home
Get Ticket
Get API Key

API Reference
Projects
Dashboard
Milestones
Tasklists
Meetings
Documents
Timesheet
Forums
Users

 
Forums API

How to Get All User Messages ?
How to Add a Message ?
How to Update a Message ?
How to Delete a Message ?
How to Get All Message Categories ?
How to Add Message Category ?
How to Get Message Comments ?
How to Add Message Comment ?
How to Remove the Forum Attachment ?
How to Download the Forum Attachment ?

How to Get All User Messages

Method Name :
http://projects.zoho.com/portal/{PortalName}/api/private/xml/messages
API Description :
Given the ticket, apikey, projectId and category returns all the messages on successful authentication.
Parameters to be passed :
ticket, apikey, projectId,categoryId
Sample Call
<form method="post" action="http://projects.zoho.com/portal/{PortalName}/api/private/xml/messages?apikey=[ApiKey]&ticket=[ticket]">
<input type="hidden" name="projId" value="">
<input type="hidden" name="catId" value="">
<input type="hidden" name="auditIndex" value="">
<input type="hidden" name="range" value="">
<input type="submit" value="Get All User  Messages">
</form>
Output XML
<response>
<uri>/api/private/xml/messages/</uri>
- <result>
- <MessageDetails>
- <MessageDetail>
<message_id>LRMRg7/jxbOwLEeykujaCg==></message_id>
<message_title> Budget for Financial Year 2009-10 </message_title>
<message_body>Team, Get ready with all your audit reports, sales reports, revenue reports will finalize the budget today. </message_body>
<personname>John</personname>
<
loginname>W/M38onRIP8=</loginname>
<messageposttime> yyyy-mm-dd HH:MM</messageposttime>
</MessageDetail>
</MessageDetails>
</result>
</response>
Output JSON
{response:{uri:'/api/private/xml/messages/',result:{messagedetails:{messagedetail:{message_id:'LRMRg7/jxbOwLEeykujaCg==',message_title:'Budget for Financial Year 2009-10',message_body:'Team, Get ready with all your audit reports, sales reports, revenue reports will finalize the budget today.',personname:'John',loginname:'W/M38onRIP8=',messageposttime:yyyy-mm-dd HH:MM}}}}}

How to Add a Message

Method Name :
http://projects.zoho.com/portal/{PortalName}/api/private/xml/message/add/
API Description :
Given the ticket, apikey, projectid,messagetitle,messagebody a new message is created on successful authentication.
Parameters to be passed :
ticket, apikey, projectId,messagebody,messagetitle,category,attachment,notification
Sample Call
<form method="post" action="http://projects.zoho.com/portal/{PortalName}/api/private/xml/message/add/?apikey=apikey=[ApiKey]&ticket=[ticket]" enctype="multipart/form-data">
<input type="hidden" name="projId" value="">
<input name="mesgtitle" type="hidden" value="Budgeting Tips">
<textarea name="mesgbody">
Hey Team - We need to start thinking about training content and what we're going to give the team for hand-off.</textarea>
<input name="mesgcat" type="hidden" value="">
attach file<input type='file' name='uploadfile'>
<select name="toaddr" >
<option value="none" disabled="disabled">None</option>(None - Notify for no one.)
(To notify any user, kindly replace the "none" by that user zuid, and "None" by that user name)
</select>
<input type="submit" value="Add Message">
</form>
Output XML
<response>
<uri>/api/private/xml/message/add/</uri>
- <result>
- <MessageDetails>
- <MessageDetail>
<message_id>LRMRg7/jxbOwLEeykujaCg==</message_id>
<message_title>Budgeting Tips</message_title>
<message_body>Hey Team - We need to start thinking about training content and what we're going to give the team for hand-off.</message_body>
<loginname>5ZTM0/VPGG8=</loginname>
<messageposttime> yyyy-mm-dd HH:MM</messageposttime>
</MessageDetail>
</MessageDetails>
</result>
</response>
Output JSON
{response:{uri:'/api/private/xml/message/add/',result:{messagedetails:{messagedetail:{message_id:'LRMRg7/jxbOwLEeykujaCg==',message_title:'Budgeting Tips',message_body:'Hey Team - We need to start thinking about training content and what we're going to give the team for hand-off.',loginname:'5ZTM0/VPGG8=',messageposttime: yyyy-mm-dd HH:MM}}}}}

How to Update a Message

Method Name :
http://projects.zoho.com/portal/{PortalName}/api/private/xml/message/update
API Description :
Given the ticket, apikey and message Id and message details edits the message on successful authentication.
Parameters to be passed :
ticket, apikey, messageid,mesgcat
Sample Call
<http://projects.zoho.com/portal/{PortalName}/api/private/xml/message/update?apikey=[ApiKey]&ticket=[ticket]" enctype="multipart/form-data">
<input type="hidden" name="projId" value="">
<input name="mesgtitle" type="text" value="Budgeting Tips">
<textarea name="mesgbody">
Hey Team - We need to start thinking about training content and what we're going to give the team for hand-off. Can you let me know if you have better ideas about how to organize the content or otherwise let's just go do it! </textarea>
<input name="mesgcat" type="hidden">
Attach file<input type='file' name='uploadfile'>
Message Id<input type='hidden' name='mesgid' value=''>
<select style="visibility: visible;" name="toaddr" size="5" class="pmseltags">
<option value="none" disabled="disabled">None</option>
</select>
<input type="submit" value="Update Message">
</form>
Output XML
<response>
<uri>/api/private/xml/message/update/</uri>
- <result>
- <MessageDetails>
- <MessageDetail>
<message_id>LRMRg7/jxbPB2WG0iIZxeA==</message_id>
<message_title>Budgeting Tips</message_title>
<message_body>Hey Team - We need to start thinking about training content and what we're going to give the team for hand-off. Can you let me know if you have better ideas about how to organize the content or otherwise let's just go do it! </message_body>
<personname>Jasmine</personname>
<loginname>Mjh+pwI9Q5M=</loginname>
<messageposttime> yyyy-mm-dd HH:MM</messageposttime>
</MessageDetail>
</MessageDetails>
</result>
</response>
 
Output JSON
{response:{uri:'/api/private/xml/message/update/',result:{messagedetails:{messagedetail:{message_id:'LRMRg7/jxbPB2WG0iIZxeA==',message_title:'Budgeting Tips',message_body:'Hey Team - We need to start thinking about training content and what we're going to give the team for hand-off. Can you let me know if you have better ideas about how to organize the content or otherwise let's just go do it! ',personname:'Vijay.P.S',loginname:'Mjh+pwI9Q5M=',messageposttime: yyyy-mm-dd HH:MM}}}}}

How to Delete a Message

Method Name :
http://projects.zoho.com/portal/{PortalName}/api/private/xml/message/delete
API Description :
Given the ticket, apikey, projId,and messageId deletes the message on successful authentication.
Parameters to be passed :
ticket, apikey, projId,messageId
Sample Call
<form method="post" action="http://projects.zoho.com/portal/{PortalName}/api/private/xml/message/delete?apikey=[ApiKey]&ticket=[ticket]">
<input type="hidden" name="projId" value="">
<input type="text" name="messageId" value="">
<input type="submit" value="Delete Message">
</form>
Output XML
<result>Deleted Successfully</result> 
Output JSON
{result:'Deleted Successfully'}

How to Get All Message Categories

Method Name :
http://projects.zoho.com/portal/{PortalName}/api/private/xml/message/getcateg
API Description :
Given the ticket, apikey, projId returns all the message categories 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/message/getcateg?apikey=[ApiKey]&ticket=[ticket]">
<input type="hidden" name="projId" value="">
<input type="submit" value="Get Message Category">
</form>
Output XML
<response>
<uri>/api/private/xml/message/getcateg/</uri>
- <result>
- <MessageCategoryDetails>
- <MessageDetail>
<messagecategory_id>LRMRg7/jxbMVBFIWNVIp5Q==</messagecategory_id>
<message_categoryname>Tips & Ideas</message_categoryname>
</MessageDetail>
- <MessageDetail>
<messagecategory_id>LRMRg7/jxbMjkFIWNVIp5Q==</messagecategory_id>
<message_categoryname>Budget</message_categoryname>
</MessageDetail>
- <MessageDetail>
<messagecategory_id>LRMRg7/jxbMVBFjklVIp5Q==</messagecategory_id>
<message_categoryname>Accounts</message_categoryname>
</MessageDetail>
</MessageCategoryDetails>
</result>
</response>
Output JSON
{response:{uri:'/api/private/xml/message/getcateg/',result:{messagecategorydetails:{messagedetail:[{messagecategory_id:'LRMRg7/jxbMVBFIWNVIp5Q==',message_categoryname:'Tips & Ideas'},{messagecategory_id:'LRMRg7/jxbMjkFIWNVIp5Q==',message_categoryname:'Budget'},{messagecategory_id:'LRMRg7/jxbMVBFjklVIp5Q==',message_categoryname:'Accounts'}]}}}}

How to Add Message Category

Method Name :
http://projects.zoho.com/portal/{PortalName}/api/private/xml/message/addcateg
API Description :
Given the ticket, apikey, projIdand category name adds and returns the message category on successful authentication.
Parameters to be passed :
ticket, apikey, projId,categoryname
Sample Call
<form method="post" action="http://projects.zoho.com/portal/{PortalName}/api/private/xml/message/addcateg?apikey=[ApiKey]&ticket=[ticket]">
<input type="hidden" name="projId" value="">
<input type="text" name="categname" value="Sales">
<input type="submit" value="Add Message Category">
</form>
Output XML
<response>
<uri>/api/private/xml/message/addcateg/</uri>
- <result>
- <MessageCategoryDetails>
- <MessageDetail>
<messagecategory_id>LRMRg7/jxbMVBFIWNVIp5Q==</messagecategory_id>
<message_categoryname>Sales</message_categoryname>
</MessageDetail>
</MessageCategoryDetails>
</result>
</response>
Output JSON
{response:{uri:'/api/private/xml/message/addcateg/',result:{messagecategorydetails:{messagedetail:{messagecategory_id:'LRMRg7/jxbMVBFIWNVIp5Q==',message_categoryname:'Sales'}}}}}

How to Get Message Comments

Method Name :
http://projects.zoho.com/portal/{PortalName}/api/private/xml/message/fetchcomments
API Description :
Given the ticket, apikey, messageId returns the comments for the message on successful authentication.
Parameters to be passed :
ticket, apikey, messageId
Sample Call
<form method="post" action="http://projects.zoho.com/portal/{PortalName}/api/private/xml/message/fetchcomments?apikey=[ApiKey]&ticket=[ticket]">
<input type="hidden" name="messageId" value="">
<input type="submit" value="Get Message Comments">
</form>
Output XML
<response>
<uri>/api/private/xml/message/fetchcomments</uri>
- <result>
- <MessageCommentDetails>
- <MessageComment>
<messagecomment_id>LRMRg7/mlkMVBFIWNVIp5Q==</messagecomment_id>
<message_commentbody>Thanks for the idea.</message_commentbody>
<message_loginname>Mjh+pwI9Q5M=</message_loginname>
<message_commentposttime> yyyy-mm-dd HH:MM</message_commentposttime>
<message_lastmodtime> yyyy-mm-dd HH:MM</message_lastmodtime>
<message_commentstatusinfo>0</message_commentstatusinfo>
</MessageComment>
</MessageCommentDetails>
</result>
</response>
Output JSON
{response:{uri:'/api/private/xml/message/fetchcomments',result:{messagecommentdetails:{messagecomment:{messagecomment_id:'LRMRg7/mlkMVBFIWNVIp5Q==',message_commentbody:'Thanks for the idea.',message_loginname:'Mjh+pwI9Q5M=',message_commentposttime: yyyy-mm-dd HH:MM,message_lastmodtime: yyyy-mm-dd HH:MM,message_commentstatusinfo:0}}}}}

How to Add Message Comment

Method Name :
http://projects.zoho.com/portal/{PortalName}/api/private/xml/message/addcomment
API Description :
Given the ticket, apikey, messageId,comment and projectid adds the comment for the message on successful authentication.
Parameters to be passed :
ticket, apikey, messageid, comment and projId
Sample Call
<form method="post" action="http://projects.zoho.com/portal/{PortalName}/api/private/xml/message/addcomment?apikey=[ApiKey]&ticket=[ticket]">
<input type="text" name="messageId" value="">
Comment:<input type="text" name="combody" value="Suggested idea worked fine for me">
<input type="hidden" name="projId" value="">
<input type="submit" value="Add Comment">
</form>
Output XML
<response>
<uri>/api/private/xml/message/addcomment</uri>
- <result>
<messagecomment_id>LRMRg7/jxbMQl1SIIKhStA==</messagecomment_id>
</result>
</response>
Output JSON
{response:{uri:'/api/private/xml/message/addcomment',result:{messagecomment_id:'LRMRg7/jxbMQl1SIIKhStA=='}}}

How to Remove the Forum Attachment

Method Name :
http://projects.zoho.com/portal/{PortalName}/api/private/xml/message/delattach
API Description :
Given the ticket, apikey, messageId,Attachment Id and Project Id deletes the attachment message on successful authentication.
Parameters to be passed :
ticket, apikey, messageid, attachmentid and projId
Sample Call
<form method="post" action="http://projects.zoho.com/portal/{PortalName}/api/private/xml/message/delattach?apikey=[ApiKey]&ticket=[ticket]">
<input type="text" name="messageId" value="">
Attachment Id:<input type="text" name="attId" value="">
<input type="hidden" name="projId" value="">
<input type="submit" value="Delete Message Attachment">
</form>
Output XML
<response>
<uri>/api/private/xml/message/delattach</uri>
<result>Deleted Successfully</result>
</response>

Output JSON
{uri:'/api/private/xml/message/delattach',result:'DeletedSuccessfully'}}

How to Download the Forum Attachment

Method Name :
http://projects.zoho.com/portal/{PortalName}/api/private/xml/message/dloadfile
API Description :
Given the ticket, apikey, message Id,Attachment Id and project Id,filename downloads the attachment  on successful authentication.
Parameters to be passed :
ticket, apikey, message Id, attachment Id and projId,filename
Sample Call
<form method="post" action="http://projects.zoho.com/portal/{PortalName}/api/private/xml/message/dloadfile?apikey=[ApiKey]&ticket=[ticket]">
MesgId:<input type="text" name="messageId" value="">
Attachment Id:<input type="text" name="attId" value="">
Project Id<input type="hidden" name="projId" value="">
File Name<input type="hidden" name="filename" value="">
 <input type="submit" value="Delete Message Attachment">
</form>
Output XML
<result>
http://projects.zoho.com/portal/{PortalName}/saveAttachment/api.jpg?file=b4s5ePmHlWT3Q%2B6TCP%2BOxUy6WWiiKU%2Fs
</result>
Output JSON
{result:'http://projects.zoho.com/portal/{PortalName}/saveAttachment/api.jpg?file=b4s5ePmHlWT3Q%2B6TCP%2BOxUy6WWiiKU%2Fs'}

API Community : Share your ideas, ask questions, and help fellow developers on the Zoho Projects - API Community


Post a comment

Your Name or E-mail ID (mandatory)

Note: Your comment will be published after approval of the owner.





 RSS of this page