HTTP request
GET https://api.wevoteusa.org/apis/v1/voterBookmarkOnSave (Jump to "Try It Now")
Required Parameters
| Parameter name | Value | Description |
| api_key | string (from post, cookie, or get (in that order)) | The unique key provided to any organization using the WeVoteServer APIs |
| voter_device_id | string | An 88 character unique identifier linked to a voter record on the server |
| kind_of_ballot_item | string | What is the type of ballot item for which we are saving the 'on' status? (kind_of_ballot_item is either "OFFICE", "CANDIDATE", "POLITICIAN" or "MEASURE") |
| ballot_item_id | integer | The unique internal identifier for this ballot_item (either ballot_item_id OR ballot_item_we_vote_id required -- not both. If it exists, ballot_item_id is used instead of ballot_item_we_vote_id) |
| ballot_item_we_vote_id | string | The unique identifier for this ballot_item across all networks (either ballot_item_id OR ballot_item_we_vote_id required -- not both. NOTE: In the future we might support other identifiers used in the industry. |
Response
{
"status": string (description of what happened),
"success": boolean (did the save happen?),
"ballot_item_id": integer,
"ballot_item_we_vote_id": string,
"kind_of_ballot_item": string (CANDIDATE, MEASURE),
}
Response Status Codes
| Code | Description |
| VALID_VOTER_DEVICE_ID_MISSING | Cannot proceed. A valid voter_device_id parameter was not included. |
| VALID_VOTER_ID_MISSING | Cannot proceed. Missing voter_id while trying to save. |
| BOOKMARK_ON_OFFICE CREATE/UPDATE ITEM_BOOKMARKED | |
| BOOKMARK_ON_CANDIDATE CREATE/UPDATE ITEM_BOOKMARKED | |
| BOOKMARK_ON_MEASURE CREATE/UPDATE ITEM_BOOKMARKED |
Try It Now: API Variables
Save or create private 'bookmark on' state for the current voter for a measure, an office or candidate.