Comments

Fields

id

comment unique identifier number

author_id

comment's author unique identifier number

text

comment text string

created-at

comment creation time

updated-at

comment last update time

create

creates a new comment and returns it

Parameters

• comment[commentable_type]: COMMENT_COMMENTABLE_TYPE (what type of item you will be commenting) - mandatory
• comment[commentable_CID]: COMMENT_COMMENTABLE_CID (the project context ID of the item to be will be commenting) - mandatory
• comment[text]: COMMENT_TEXT (text of the new comment) - mandatory
• project: PROJECT_ALIAS (alias of a specific project) - mandatory
• company: COMPANY_ALIAS (passed in as a subdomain) - mandatory
• format: xml | json - not mandatory, defaults to the HTTP Accept header.
• callback: JAVASCRIPT_FUNCTION (a javascript function identifier) - not mandatory, only used on json

Endpoint examples

	http://company_alias.goplanapp.com/project_alias/api/comments/create - pass the other parameters by POST

	http://company_alias.goplanapp.com/project_alias/api/comments/create?&comment;[commentable_type]=task&comment;[commentable_cid]=6&comment;[text]=Let us discuss the development methodologies to use in this project

	http://company_alias.goplanapp.com/project_alias/api/comments/create?format=json&callback;=handlerfunction&comment;[commentable_type]=task&comment;[commentable_cid]=6&comment;[text]=Let us discuss the development methodologies to use in this project

Output Formats

• XML

  
  <?xml version="1.0" encoding="UTF-8"?>		
  <comment>
  	<author-id type="integer">1</author-id>
  	<created-at type="datetime">2009/06/02 16:47:44 +0100</created-at>
  	<id type="integer">49</id>
  	<text>Let us discuss the development methodologies to use in this project</text>
  	<updated-at type="datetime">2009/06/02 16:47:44 +0100</updated-at>
  </comment>
  		

• JSON

  
  {"comment": {"updated_at": "2009/07/13 16:47:44 +0100", "text": "Let us discuss the development methodologies to use in this project", "id": 49, "author_id": 1, "created_at": "2009/06/02 16:47:44 +0100"}}
  		

Update

updates a comment and returns it

Parameters

• id: ID (the unique identifier of the comment to be edited) - mandatory
• comment[text]: COMMENT_TEXT (text of the new comment) - mandatory
• project: PROJECT_ALIAS (alias of a specific project) - mandatory
• company: COMPANY_ALIAS (passed in as a subdomain) - mandatory
• format: xml | json - not mandatory, defaults to the HTTP Accept header.
• callback: JAVASCRIPT_FUNCTION (a javascript function identifier) - not mandatory, only used on json

Endpoint examples

	http://company_alias.goplanapp.com/project_alias/api/comments/update - pass the other parameters by POST

	http://company_alias.goplanapp.com/project_alias/api/comments/update?id=49&comment;[text]=Let us discuss the development methodologies to use in this project and also the milestones.

	http://company_alias.goplanapp.com/project_alias/api/comments/update?id=49&format;=json&callback;=handlerfunction&comment;[text]=Let us discuss the development methodologies to use in this project and also the milestones.

Output Formats

• XML

  
  <?xml version="1.0" encoding="UTF-8"?>		
  <comment>
  	<author-id type="integer">1</author-id>
  	<created-at type="datetime">2009/06/02 16:47:44 +0100</created-at>
  	<id type="integer">49</id>
  	<text>Let us discuss the development methodologies to use in this project and also the milestones.</text>
  	<updated-at type="datetime">2009/06/02 17:47:44 +0100</updated-at>
  </comment>
  		

• JSON

  
  {"comment": {"updated_at": "2009/07/13 16:47:44 +0100", "text": "Let us discuss the development methodologies to use in this project and also the milestones.", "id": 49, "author_id": 1, "created_at": "2009/06/02 16:47:44 +0100"}}
  		

Destroy

deletes a comment and returns it

Parameters

• id: ID (the unique identifier of the comment to be edited) - mandatory
• project: PROJECT_ALIAS (alias of a specific project) - mandatory
• company: COMPANY_ALIAS (passed in as a subdomain) - mandatory
• format: xml | json - not mandatory, defaults to the HTTP Accept header.
• callback: JAVASCRIPT_FUNCTION (a javascript function identifier) - not mandatory, only used on json

Endpoint examples

	http://company_alias.goplanapp.com/project_alias/api/comments/destroy - pass the other parameters by POST

	http://company_alias.goplanapp.com/project_alias/api/comments/destroy?id=49

	http://company_alias.goplanapp.com/project_alias/api/comments/update?id=49&format;=json

Output Formats

• XML

  
  <?xml version="1.0" encoding="UTF-8"?>		
  <comment>
  	<author-id type="integer">1</author-id>
  	<created-at type="datetime">2009/06/02 16:47:44 +0100</created-at>
  	<id type="integer">49</id>
  	<text>Let us discuss the development methodologies to use in this project and also the milestones.</text>
  	<updated-at type="datetime">2009/06/02 17:47:44 +0100</updated-at>
  </comment>
  		

• JSON

  
  {"comment": {"updated_at": "2009/07/13 16:47:44 +0100", "text": "Let us discuss the development methodologies to use in this project and also the milestones.", "id": 49, "author_id": 1, "created_at": "2009/06/02 17:47:44 +0100"}}