• Documentation
  • registration
    • registerapp
    • editapp
    • logs
  • authentication
    • server-side
    • client-side
    • password
    • faq
  • api
    • member
      • get
      • list
      • create
      • update
      • faq
    • profileImage
      • create
      • delete
    • idea
      • get
      • list
      • create
      • update
      • delete
      • faq
    • ideaAttachment
      • create
      • delete
      • faq
    • comment
      • get
      • list
      • create
      • update
      • delete
      • faq
    • commentVote
      • get
      • list
      • create
      • delete
      • faq
    • blog
      • list
    • blogComment
      • get
      • list
      • create
      • delete
      • faq
    • tag
      • list
      • create
      • delete
      • faq
    • vote
      • list
      • create
      • delete
      • faq
    • chipVote
      • list
      • create
      • update
      • delete
      • faq
    • activity
      • get
      • list
      • faq
    • status
      • list
      • faq
    • category
      • list
      • faq
    • update
      • get
      • list
      • create
      • delete
      • faq
    • updateHifive
      • get
      • list
      • create
      • delete
      • faq
    • updateComment
      • get
      • list
      • create
      • delete
      • faq
    • updateCommentHifive
      • get
      • list
      • create
      • delete
      • faq
    • group
      • get
      • list
      • create
      • update
      • delete
      • faq
    • campaign
      • get
      • list
      • create
      • update
      • delete
      • faq
    • mobileDevice
      • get
      • list
      • create
      • update
      • delete
      • faq
    • emailValidation
      • post
    • notification
      • get
      • list
      • delete
      • faq
    • search
      • get
    • report
      • get
      • list
      • create
      • delete
    • apilog
      • get
      • list
    • widget
      • ideaList
      • viewIdea
      • postIdea
      • communityStats

GET commentVote {#get}

Get data of one commentVote object.

Parameters

Parameters | Detail ----------------------- | ------------- format
optional|Specifies returned data format
Accepted value: "json", "xml"

Resource Information

Authentication: See Access Permission

HTTP Methods: GET

Request URL Format: https://{api_domain}/api3/commentVote

Access Permission {#listPermission}

Access to data varies based on system settings and requester roles. See Oauth 2.0 for details on authentication.

Private WebStorms: Requester must authenticate to get data.

Public WebStorms: No authentication required to get data.

Errors

• Invalid object ID or you don't have access to this object

Example Request

• Method: GET
• Header: Authorization=Bearer 85f7b2462570acdde9a458ba6495b8763dcd040c

• URL: https://example.brightidea.com/api3/commentVote/?comment_id=353AB424-4B74-4930-A395-168505083CAD

  ~~~ { "commentVotelist": [ { "commentid": "353AB424-4B74-4930-A395-168505083CAD", "datecreated": "2011-12-09 15:50:19.603", "type": "demote", "comment": { "id": "353AB424-4B74-4930-A395-168505083CAD", "datecreated": "2011-12-09 15:43:11.137", "text": "test comment", "idea": { "id": "94D1CA24-3CE7-4FA7-AF36-4CB06D259325", "datecreated": "2011-12-09 14:39:43.863", "datemodified": "2011-12-09 14:39:43.863", "title": "Friday Idea", "description": "Today is Friday", "visible": true, "anonymous": false, "ideacode": "D201", "stageid": null, "stepid": null, "campaign": { "id": "CE640FD7-42AF-45A2-9137-D21D65B43AD2", "name": "Going Green Challenge", "description": "This campaign is for Going Green Challenge ", "datecreated": "2011-05-05 16:09:54.997", "startdate": "2011-05-05 16:09:54.997", "enddate": "2012-05-04 16:09:54.997" } } }, "member": { "id": "AB3A6BD3-B7AA-4FF9-906D-03178FE2C4F5", "email": "jdoe@example.com", "screenname": "John Doe", "firstname": "John", "lastname": "Doe", "jobtitle": "Sales", "address": "123 fake street", "phone": "(123) 456-789", "mobilephone": "(987) 654-3210", "externaluserid": "", "skills": "Selling Software", "workhistory": "Worked at sales.com", "photourl": "https://example.brightideatest.com/api3/file/047047BB-A376-45D2-8113-1C17ECAF21FE?format=binary&thumbsize=100", "datecreated": "2011-09-09 16:07:12.870", "datemodified": "2013-09-26 09:41:35.583", "active": true, "photofileid": "047047BB-A376-45D2-8113-1C17ECAF21FE", "department": "Sales" } }, { "commentid": "353AB424-4B74-4930-A395-168505083CAD", "datecreated": "2011-12-09 15:43:15.527", "type": "promote", "comment": { "id": "353AB424-4B74-4930-A395-168505083CAD", "datecreated": "2011-12-09 15:43:11.137", "text": "test comment", "idea": { "id": "94D1CA24-3CE7-4FA7-AF36-4CB06D259325", "datecreated": "2011-12-09 14:39:43.863", "datemodified": "2011-12-09 14:39:43.863", "title": "Friday Idea", "description": "Today is Friday", "visible": true, "anonymous": false, "ideacode": "D201", "stageid": null, "stepid": null, "campaign": { "id": "CE640FD7-42AF-45A2-9137-D21D65B43AD2", "name": "Going Green Challenge", "description": "This campaign is for Going Green Challenge ", "datecreated": "2011-05-05 16:09:54.997", "startdate": "2011-05-05 16:09:54.997", "enddate": "2012-05-04 16:09:54.997" } } }, "member": { "id": "DAE57893-36FD-4158-9F27-803775380D0B", "email": "max.power@example.com", "screenname": "Max Power", "firstname": "Max", "lastname": "Power", "jobtitle": "Safety Inspector", "address": "742 Evergreen Terrace, Springfield, IL", "phone": "(123)456-7890", "mobilephone": "(987)654-3210", "externaluserid": "123", "skills": "Boxer, Mascot, Astronaut, Baby proofer, Truck driver, Hippie, Plow Driver, Food Critic", "workhistory": "Conceptual Artist, Mayor, Country Western Manager, Garbage Commissioner, Mountain Climber", "photourl": "https://example.brightideatest.com/api3/file/3557DDBA-0671-4D0D-8FA4-70A211A5B959?format=binary&thumbsize=100", "datecreated": "2011-05-05 16:09:52.720", "datemodified": "2013-12-12 15:33:54.090", "active": true, "photofileid": "3557DDBA-0671-4D0D-8FA4-70A211A5B959", "department": "Safety Department" } } ], "stats": { "total": "2", "pagecount": 1, "current_page": 1 } } ~~~

LIST commentVote {#list}

Get data on a list of commentVote objects. Objects are order by created date descending by default.

On retrieving large set of data, requester should use pagination parameters such as page and page_size to manage multiple requests.

Parameters

Parameters | Detail ----------------------------------- | ----------------------------------- comment_id
optional |Filter return by comment ID
Sample value: "11111111-1111-1111-1111-111111111111" member_id
optional |Filter return by ID of commentVote submitter
Sample value: "11111111-1111-1111-1111-111111111111" type
optional |Filter return by commentVote type
Accepted Value: "promote", "demote" date_created
optional |Filter return by commentVote created date. Response contains all ideas created within the 24 hours of the specified date
Sample value: "12/06/2009" page_size
optional |Specifies number of records returns per page. Default: 20. Minimum: 1. Maximum: 100
Sample value: 50 page
optional |Specifies which page of records to return. Default: 1. Minimum: 1. Maximum: {pagecount}
Sample value: 5 order
optional |A SQL style string that specifies the order the records should return in.
Sample value: "datecreated ASC, ideaid DESC".
Accepted attributes: "ideaid", "type", "date_created" format
optional |Specifies returned data format
Accepted value: "json", "xml"

Resource Information

Authentication: See Access Permission for LIST commentVote

HTTP Methods: GET

Request URL Format: https://{api_domain}/api3/commentVote

Access Permission {#listPermission}

Access to data varies base on system setting and requester roles. See Authentication for details on authentication.

Private WebStorms: Requester must authenticate to get data.

Public WebStorms: No authentication required to get data.

Errors

• Invalid object ID or you don't have access to this object

Example Request

• Method: GET
• Header: Authorization=Bearer 85f7b2462570acdde9a458ba6495b8763dcd040c

• URL: https://example.brightidea.com/api3/commentVote?page_size=2&page=4

  ~~~ { "commentVotelist": [ { "commentid": "353AB424-4B74-4930-A395-168505083CAD", "datecreated": "2011-12-09 15:50:19.603", "type": "demote", "comment": { "id": "353AB424-4B74-4930-A395-168505083CAD", "datecreated": "2011-12-09 15:43:11.137", "text": "test comment", "idea": { "id": "94D1CA24-3CE7-4FA7-AF36-4CB06D259325", "datecreated": "2011-12-09 14:39:43.863", "datemodified": "2011-12-09 14:39:43.863", "title": "Friday Idea", "description": "Today is Friday", "visible": true, "anonymous": false, "ideacode": "D201", "stageid": null, "stepid": null, "campaign": { "id": "CE640FD7-42AF-45A2-9137-D21D65B43AD2", "name": "Going Green Challenge", "description": "This campaign is for Going Green Challenge ", "datecreated": "2011-05-05 16:09:54.997", "startdate": "2011-05-05 16:09:54.997", "enddate": "2012-05-04 16:09:54.997" } } }, "member": { "id": "AB3A6BD3-B7AA-4FF9-906D-03178FE2C4F5", "email": "jdoe@example.com", "screenname": "John Doe", "firstname": "John", "lastname": "Doe", "jobtitle": "Sales", "address": "123 fake street", "phone": "(123) 456-789", "mobilephone": "(987) 654-3210", "externaluserid": "", "skills": "Selling Software", "workhistory": "Worked at sales.com", "photourl": "https://example.brightideatest.com/api3/file/047047BB-A376-45D2-8113-1C17ECAF21FE?format=binary&thumbsize=100", "datecreated": "2011-09-09 16:07:12.870", "datemodified": "2013-09-26 09:41:35.583", "active": true, "photofileid": "047047BB-A376-45D2-8113-1C17ECAF21FE", "department": "Sales" } }, { "commentid": "353AB424-4B74-4930-A395-168505083CAD", "datecreated": "2011-12-09 15:43:15.527", "type": "promote", "comment": { "id": "353AB424-4B74-4930-A395-168505083CAD", "datecreated": "2011-12-09 15:43:11.137", "text": "test comment", "idea": { "id": "94D1CA24-3CE7-4FA7-AF36-4CB06D259325", "datecreated": "2011-12-09 14:39:43.863", "datemodified": "2011-12-09 14:39:43.863", "title": "Friday Idea", "description": "Today is Friday", "visible": true, "anonymous": false, "ideacode": "D201", "stageid": null, "stepid": null, "campaign": { "id": "CE640FD7-42AF-45A2-9137-D21D65B43AD2", "name": "Going Green Challenge", "description": "This campaign is for Going Green Challenge ", "datecreated": "2011-05-05 16:09:54.997", "startdate": "2011-05-05 16:09:54.997", "enddate": "2012-05-04 16:09:54.997" } } }, "member": { "id": "DAE57893-36FD-4158-9F27-803775380D0B", "email": "lsmith@example.com", "screenname": "Lillian Smith", "firstname": "Lillian", "lastname": "Smith", "jobtitle": "Quality Inspector", "address": "742 Evergreen Terrace, Springfield, IL", "phone": "(123)456-7890", "mobilephone": "(987)654-3210", "externaluserid": "123", "skills": "Boxer, Mascot, Plow Driver, Food Critic", "workhistory": "Country Western Manager, Garbage Commissioner", "photourl": "https://example.brightideatest.com/api3/file/3557DDBA-0671-4D0D-8FA4-70A211A5B959?format=binary&thumbsize=100", "datecreated": "2011-05-05 16:09:52.720", "datemodified": "2013-12-12 15:33:54.090", "active": true, "photofileid": "3557DDBA-0671-4D0D-8FA4-70A211A5B959", "department": "Quality Department" } } ], "stats": { "total": "8", "pagecount": 4, "current_page": 4 } } ~~~

CREATE commentVote {#create}

Create a commentVote object.

Requester must have access to the Campaign in order to create a commentVote in it.

Parameters

Parameters | Detail ----------------------------------- | ----------------------------------- comment_id
required |This is the ID of the comment where the vote applies
Sample value: "11111111-1111-1111-1111-111111111111" type
required |This is the type of vote
Accepted Value: "promote", "demote" format
optional |Specifies returned data format
Accepted value: "json", "xml"

Resource Information

Authentication: Required. See Authentication for details on authentication.

HTTP Methods: POST

Request URL Format: https://{api_domain}/api3/commentVote

Access Permission

Requester must have access to the Campaign in order to create a commentVote in it. See Authentication for details on authentication.

Requester can only create commentVote for himself. Only one commentVote is allowed per member per comment.

Errors

• Invalid comment ID

• Missing required parameter

• Vote type must one of these values: "promote", "demote"

Example Request

• Method: POST
• Header: Authorization=Bearer 85f7b2462570acdde9a458ba6495b8763dcd040c
• URL: https://example.brightidea.com/api3/commentVote

• Form data:

  • comment_id=09599E37-BECE-4618-8667-8AF4F8A99B44
  • type=promote

  ~~~ { "commentVote": { "commentid": "09599E37-BECE-4618-8667-8AF4F8A99B44", "datecreated": "2013-12-24 16:05:47.640", "type": "promote", "comment": { "id": "09599E37-BECE-4618-8667-8AF4F8A99B44", "datecreated": "2011-12-09 15:43:24.810", "text": "new comment", "idea": { "id": "94D1CA24-3CE7-4FA7-AF36-4CB06D259325", "datecreated": "2011-12-09 14:39:43.863", "datemodified": "2011-12-09 14:39:43.863", "title": "Friday Idea", "description": "Today is Friday", "visible": true, "anonymous": false, "ideacode": "D201", "stageid": null, "stepid": null, "campaign": { "id": "CE640FD7-42AF-45A2-9137-D21D65B43AD2", "name": "Going Green Challenge", "description": "This campaign is for Going Green Challenge ", "datecreated": "2011-05-05 16:09:54.997", "startdate": "2011-05-05 16:09:54.997", "enddate": "2012-05-04 16:09:54.997" } } }, "member": { "id": "15B35D1E-52E1-4660-A38C-BF7BE5F50789", "email": "lsmith@example.com", "screenname": "Lillian Smith", "firstname": "Lillian", "lastname": "Smith", "jobtitle": "Quality Inspector", "address": "742 Evergreen Terrace, Springfield, IL", "phone": "(123)456-7890", "mobilephone": "(987)654-3210", "skills": "Truck driver, Plow Driver, Food Critic", "workhistory": "Mayor, Country Western Manager, Garbage Commissioner", "datecreated": "2011-07-19 15:23:52.740", "datemodified": "2013-09-25 11:06:47.900", "active": true, "department": "Quality Department" } }, "totalcount": 1, "promotecount": 2, "demotecount": 1 } ~~~

DELETE commentVote {#delete}

Delete a commentVote object.

Requester can delete his own submitted commentVote.

Parameters

Parameters | Detail ----------------------------------------| ----------------------------------- comment_id
required |This is the ID of the comment where the vote applies
Sample value: "11111111-1111-1111-1111-111111111111" format
optional |Specifies returned data format
Accepted value: "json", "xml"

Resource Information

• Authentication: Required. See Authentication for details on authentication.
• HTTP Methods: DELETE
• Request URL Format: https://{api_domain}/api3/commentVote

Access Permission

Requester can delete his own submitted vote.

Errors

• Invalid GUID received

Example Request

• Method: DELETE
• Header: Authorization=Bearer 85f7b2462570acdde9a458ba6495b8763dcd040c

• URL: https://example.brightidea.com/api3/commentVote

  ~~~ { "message": "success", "code": 200 } ~~~

FAQ {#faq}

Question: LIST commentVote only return 100 objects maximum per request. How do I retrieve more results.

Answer: LIST commentVote response is automatically paginated. You can specify which page of the result a request should return. For example, if you requested for 100 vote objects in the initial request, pass "page_size=100&page=2" to get the next 100. page_count is returned with every LIST request so your application can figure out when it hits the end.