LIST chipVote
Get data on a list of chipVote objects. Objects are ordered 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 |
---|---|
idea_id optional |
Filter return by idea ID Sample value: "11111111-1111-1111-1111-111111111111" |
member_id optional |
Filter return by ID of chipVote submitter Sample value: "11111111-1111-1111-1111-111111111111" |
date_created optional |
Filter return by chipVote 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: {page_count} Sample value: 5 |
order optional |
A SQL style string that specifies the order the records should return in. Sample value: "date_created ASC, idea_id DESC". Accepted attributes: "idea_id", "type", "date_created" |
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/chipVote
Access Permission
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/chipVote?idea_id=DAFBC930-202C-4105-B5E6-CB83A5E2EB2B
{ "chipVote_list": [ { "chips": "10" "date_created": "2013-04-29 14:41:57.237", "member": { "id": "395F9B2B-CC23-4B7E-A41D-3FCDFB580322", "email": "jadams@example.com", "screen_name": "John Adams", "first_name": "John", "last_name": "Adams", "date_created": "2013-03-21 11:25:24.633", "active": true }, "idea": { "id": "DAFBC930-202C-4105-B5E6-CB83A5E2EB2B", "date_created": "2013-04-29 14:20:22.597", "date_modified": "2013-04-30 11:14:22.383", "title": "Test Idea for the chipVote", "description": "Test Idea for the chipVote", "visible": true, "anonymous": false, "idea_code": "D634", "campaign": { "id": "0A140858-AD8A-4F97-9926-D80AD156A130", "name": "Sample Campaign", "description": "Sample Campaign Description", "date_created": "2013-03-07 17:10:38.107" } } }, { "date_created": "2013-04-18 18:45:33.193", "member": { "id": "866144B1-E302-42EF-AF80-75DE988885AE", "email": "jdoe@example.com", "screen_name": "John Doe", "first_name": "John", "last_name": "Doe", "date_created": "2013-03-07 19:09:54.563", "active": true, }, "idea": { "id": "01D31322-EDF4-4C88-A928-333C9EA4A352", "date_created": "2013-04-18 12:10:10.187", "date_modified": "2013-04-18 18:45:33.240", "title": "Test Idea for the chipVote #2", "description": "Test Idea for the chipVote #2", "visible": true, "idea_code": "D634", "campaign": { "id": "0A140858-AD8A-4F97-9926-D80AD156A130", "name": "Sample Campaign", "description": "Sample Campaign Description", "date_created": "2013-03-07 17:10:38.107" } } ], "stats": { "total": "2", "page_count": 1, "current_page": 1 } }
CREATE chipVote
Create a chipVote object.
Requester must have access to the Campaign in order to create an Vote in it.
Parameters
Parameters | Detail |
---|---|
idea_id required |
This is the ID of the idea where the Vote applies Sample value: "11111111-1111-1111-1111-111111111111" |
chip required |
This is the number of chips to Vote Sample Value: "10" |
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/chipVote
Access Permission
Requester must have access to the Campaign in order to create an idea in it. See Authentication for details on authentication.
Request can only create Vote for himself. Each member can chipVote only once per idea.
Errors
Invalid idea ID
Missing required parameter
Example Request
- Method: POST
- Header: Authorization=Bearer 85f7b2462570acdde9a458ba6495b8763dcd040c
- URL:
https://example.brightidea.com/api3/chipVote
Form data:
- idea_id=01D31322-EDF4-4C88-A928-333C9EA4A352
- chip=3
{ "chip_Vote": { "chips": "3" "date_entered": "2013-05-20 13:43:13.380", "member": { "id": "395F9B2B-CC23-4B7E-A41D-3FCDFB58032", "email": "jadams@example.com", "screen_name": "John Adams", "first_name": "John", "last_name": "Adams", "date_created": "2013-03-21 11:25:24.633", "active": true }, "idea": { "id": "8727F46F-0780-4E8D-B163-FE99AFAF68B8", "date_created": "2013-04-18 12:10:10.187", "date_modified": "2013-05-01 12:11:59.920", "title": "End user chipVote idea", "description": "End user chipVote idea", "visible": true, "anonymous": false, "idea_code": "D2679", "campaign": { "id": "51014956-486B-491C-9496-8E1529B39FA8", "name": "Chips Voting Private WS", "description": "This is a Test WS", "date_created": "2010-11-12 13:01:52.923" } } }, }
UPDATE chipVote
Update a chipVote object.
Requester must have access to the Campaign in order to create an Vote in it.
Parameters
Parameters | Detail |
---|---|
idea_id required |
This is the ID of the idea where the Vote applies Sample value: "11111111-1111-1111-1111-111111111111" |
chip required |
This is the number of chips to Vote Sample Value: "10" |
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/chipVote
Access Permission
Requester must have access to the Campaign in order to create an idea in it. See Authentication for details on authentication.
Request can increase the number of chips on the idea he previously Voted. Requester can only update the chips he submitted.
Errors
Invalid idea ID
Missing required parameter
Example Request
- Method: POST
- Header: Authorization=Bearer 85f7b2462570acdde9a458ba6495b8763dcd040c
- URL:
https://example.brightidea.com/api3/chipVote
Form data:
- idea_id=01D31322-EDF4-4C88-A928-333C9EA4A352
- chip=3
{ "chip_Vote": { "chips": "5" "date_entered": "2013-05-20 13:43:13.380", "member": { "id": "395F9B2B-CC23-4B7E-A41D-3FCDFB58032", "email": "jadams@example.com", "screen_name": "John Adams", "first_name": "John", "last_name": "Adams", "date_created": "2013-03-21 11:25:24.633", "active": true }, "idea": { "id": "8727F46F-0780-4E8D-B163-FE99AFAF68B8", "date_created": "2013-04-18 12:10:10.187", "date_modified": "2013-05-01 12:11:59.920", "title": "End user chipVote idea", "description": "End user chipVote idea", "visible": true, "anonymous": false, "idea_code": "D2679", "campaign": { "id": "51014956-486B-491C-9496-8E1529B39FA8", "name": "Chips Voting Private WS", "description": "This is a Test WS", "date_created": "2010-11-12 13:01:52.923" } } }, }
DELETE chipVote
Delete a chipVote object.
Requester can delete his own submitted Vote.
Parameters
Parameters | Detail |
---|---|
idea_id required |
This is the ID of the idea 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
: DELETERequest URL Format
: https://{api_domain}/api3/Vote
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/chipVote
{ "message": "success", "code": 200 }
FAQ
Question: LIST chipVote only return 100 objects maximum per request. How do I retrieve more results.
Answer: LIST chipVote response is automatically paginated. You can specify which page of the result a request should return. For example, if you requested for 100 idea 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.