< back to index
HTTP request
GET https://api.wevoteusa.org/apis/v1/voterGuidePossibilityPositionsRetrieve (Jump to "Try It Now")
Required Parameters
| Parameter name |
Value |
Description |
| voter_device_id |
string |
An 88 character unique identifier linked to a voter record on the server |
| voter_guide_possibility_id |
integer |
This id of the VoterGuidePossibility is required. |
| api_key |
string (from post, cookie, or get (in that order)) |
The unique key provided to any organization using the WeVoteServer APIs |
Optional Parameters
| Parameter name |
Value |
Description |
| voter_guide_possibility_position_id |
integer |
If you enter voter_guide_possibility_position_id the query will be limited to just this entry. |
Response
{
"status": string,
"success": boolean,
"voter_guide_possibility_id": integer,
"possible_position_list": list [
{
"possibility_position_id": integer,
"possibility_position_number": integer,
"ballot_item_name": string,
"ballot_item_image_url_https_medium": string,
"candidate_twitter_handle": string,
"candidate_we_vote_id": string,
"edit_position_url": string,
"google_civic_election_id": string,
"measure_we_vote_id": string,
"more_info_url_stored": string,
"more_info_url": string,
"office_we_vote_id": string,
"organization_name": string,
"organization_twitter_handle": string,
"organization_we_vote_id": string,
"political_party": string,
"position_should_be_removed": boolean,
"position_stance": string,
"position_stance_stored": string,
"position_we_vote_id": string,
"possibility_should_be_deleted": boolean,
"possibility_should_be_ignored": boolean,
"statement_text": string,
"statement_text_stored": string,
"state_code": string,
"withdrawn_from_election": boolean,
"withdrawal_date": date,
}],
}
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. A valid voter_id was not found. |
| VOTER_GUIDE_POSSIBILITY_NOT_FOUND |
A voter guide possibility was not found at that URL. |
| VOTER_GUIDE_POSSIBILITY_FOUND_WITH_URL |
A voter guide possibility entry was found. |
Try It Now: API Variables
Retrieve all the possible endorsements scraped from this particular page.