< back to index

HTTP request

GET https://api.wevoteusa.org/apis/v1/voterGuidePossibilityHighlightsRetrieve (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
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
url_to_scan	string	The url of the list of endorsements that the voter is viewing.
pdf_url	string	The url of the list of endorsements, if the endorsement was originally on a pdf.
google_civic_election_id	integer	The Google civic election ID. Provide a value, only if you want data for a prior election.

Response

{
  "status": string,
  "success": boolean,
  "url_to_scan": string,
  "pdf_url": string,
  "highlight_list": list [
    {
      "name": string,
      "we_vote_id": string,
      "display": string, ('STORED', 'DELETED', 'POSSIBILITY', or 'DEFAULT')
      "stance": string, ('SUPPORT', 'OPPOSED', or 'INFO_ONLY')
      "prior": integer, ('1' if from a prior election)
    }
  ],
  "never_highlight_on": list [
     "*.wevote.us",
     "api.wevoteusa.org",
     "localhost"
  ]
}

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 of the candidates that might be highlighted on an endorsement guide. DEFAULT = there is no entry in this organization's Voter Guide Possibility yet.

Parameter name	Value
voter_device_id:
url_to_scan:
pdf_url:
google_civic_election_id:

(opens in new window)