View Source GoogleApi.CivicInfo.V2.Model.Contest (google_api_civic_info v0.24.0)

Information about a contest that appears on a voter's ballot.

Attributes

  • ballotPlacement (type: String.t, default: nil) - A number specifying the position of this contest on the voter's ballot.
  • ballotTitle (type: String.t, default: nil) - The official title on the ballot for this contest, only where available.
  • candidates (type: list(GoogleApi.CivicInfo.V2.Model.Candidate.t), default: nil) - The candidate choices for this contest.
  • district (type: GoogleApi.CivicInfo.V2.Model.ElectoralDistrict.t, default: nil) - Information about the electoral district that this contest is in.
  • electorateSpecifications (type: String.t, default: nil) - A description of any additional eligibility requirements for voting in this contest.
  • level (type: list(String.t), default: nil) - The levels of government of the office for this contest. There may be more than one in cases where a jurisdiction effectively acts at two different levels of government; for example, the mayor of the District of Columbia acts at "locality" level, but also effectively at both "administrative-area-2" and "administrative-area-1".
  • numberElected (type: String.t, default: nil) - The number of candidates that will be elected to office in this contest.
  • numberVotingFor (type: String.t, default: nil) - The number of candidates that a voter may vote for in this contest.
  • office (type: String.t, default: nil) - The name of the office for this contest.
  • primaryParties (type: list(String.t), default: nil) - If this is a partisan election, the name of the party/parties it is for.
  • referendumBallotResponses (type: list(String.t), default: nil) - The set of ballot responses for the referendum. A ballot response represents a line on the ballot. Common examples might include "yes" or "no" for referenda. This field is only populated for contests of type 'Referendum'.
  • referendumBrief (type: String.t, default: nil) - Specifies a short summary of the referendum that is typically on the ballot below the title but above the text. This field is only populated for contests of type 'Referendum'.
  • referendumConStatement (type: String.t, default: nil) - A statement in opposition to the referendum. It does not necessarily appear on the ballot. This field is only populated for contests of type 'Referendum'.
  • referendumEffectOfAbstain (type: String.t, default: nil) - Specifies what effect abstaining (not voting) on the proposition will have (i.e. whether abstaining is considered a vote against it). This field is only populated for contests of type 'Referendum'.
  • referendumPassageThreshold (type: String.t, default: nil) - The threshold of votes that the referendum needs in order to pass, e.g. "two-thirds". This field is only populated for contests of type 'Referendum'.
  • referendumProStatement (type: String.t, default: nil) - A statement in favor of the referendum. It does not necessarily appear on the ballot. This field is only populated for contests of type 'Referendum'.
  • referendumSubtitle (type: String.t, default: nil) - A brief description of the referendum. This field is only populated for contests of type 'Referendum'.
  • referendumText (type: String.t, default: nil) - The full text of the referendum. This field is only populated for contests of type 'Referendum'.
  • referendumTitle (type: String.t, default: nil) - The title of the referendum (e.g. 'Proposition 42'). This field is only populated for contests of type 'Referendum'.
  • referendumUrl (type: String.t, default: nil) - A link to the referendum. This field is only populated for contests of type 'Referendum'.
  • roles (type: list(String.t), default: nil) - The roles which this office fulfills.
  • sources (type: list(GoogleApi.CivicInfo.V2.Model.Source.t), default: nil) - A list of sources for this contest. If multiple sources are listed, the data has been aggregated from those sources.
  • special (type: String.t, default: nil) - "Yes" or "No" depending on whether this a contest being held outside the normal election cycle.
  • type (type: String.t, default: nil) - The type of contest. Usually this will be 'General', 'Primary', or 'Run-off' for contests with candidates. For referenda this will be 'Referendum'. For Retention contests this will typically be 'Retention'.

Summary

Functions

Unwrap a decoded JSON object into its complex fields.

Types

@type t() :: %GoogleApi.CivicInfo.V2.Model.Contest{
  ballotPlacement: String.t() | nil,
  ballotTitle: String.t() | nil,
  candidates: [GoogleApi.CivicInfo.V2.Model.Candidate.t()] | nil,
  district: GoogleApi.CivicInfo.V2.Model.ElectoralDistrict.t() | nil,
  electorateSpecifications: String.t() | nil,
  level: [String.t()] | nil,
  numberElected: String.t() | nil,
  numberVotingFor: String.t() | nil,
  office: String.t() | nil,
  primaryParties: [String.t()] | nil,
  referendumBallotResponses: [String.t()] | nil,
  referendumBrief: String.t() | nil,
  referendumConStatement: String.t() | nil,
  referendumEffectOfAbstain: String.t() | nil,
  referendumPassageThreshold: String.t() | nil,
  referendumProStatement: String.t() | nil,
  referendumSubtitle: String.t() | nil,
  referendumText: String.t() | nil,
  referendumTitle: String.t() | nil,
  referendumUrl: String.t() | nil,
  roles: [String.t()] | nil,
  sources: [GoogleApi.CivicInfo.V2.Model.Source.t()] | nil,
  special: String.t() | nil,
  type: String.t() | nil
}

Functions

@spec decode(struct(), keyword()) :: struct()

Unwrap a decoded JSON object into its complex fields.