Network.Google.CivicInfo

An API for accessing civic information.

See: Google Civic Information API Reference

Service Configuration

civicInfoService :: Service

Default request referring to version v2 of the Google Civic Information API. This contains the host and root path used as a starting point for constructing service requests.

API Declaration

type CivicInfoAPI = ElectionsVoterInfoQueryResource :<|> (ElectionsElectionQueryResource :<|> (DivisionsSearchResource :<|> (RepresentativesRepresentativeInfoByDivisionResource :<|> RepresentativesRepresentativeInfoByAddressResource)))

Represents the entirety of the methods and resources available for the Google Civic Information API service.

Resources

civicinfo.divisions.search

module Network.Google.Resource.CivicInfo.Divisions.Search

civicinfo.elections.electionQuery

module Network.Google.Resource.CivicInfo.Elections.ElectionQuery

civicinfo.elections.voterInfoQuery

module Network.Google.Resource.CivicInfo.Elections.VoterInfoQuery

civicinfo.representatives.representativeInfoByAddress

module Network.Google.Resource.CivicInfo.Representatives.RepresentativeInfoByAddress

civicinfo.representatives.representativeInfoByDivision

module Network.Google.Resource.CivicInfo.Representatives.RepresentativeInfoByDivision

Types

RepresentativeInfoResponseDivisions

data RepresentativeInfoResponseDivisions

Political geographic divisions that contain the requested address.

See: representativeInfoResponseDivisions smart constructor.

Instances

Eq RepresentativeInfoResponseDivisions

Data RepresentativeInfoResponseDivisions

Show RepresentativeInfoResponseDivisions

Generic RepresentativeInfoResponseDivisions

ToJSON RepresentativeInfoResponseDivisions

FromJSON RepresentativeInfoResponseDivisions

type Rep RepresentativeInfoResponseDivisions

representativeInfoResponseDivisions

Arguments

:: HashMap Text GeographicDivision

rirdAddtional

-> RepresentativeInfoResponseDivisions

Creates a value of RepresentativeInfoResponseDivisions with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• rirdAddtional

rirdAddtional :: Lens' RepresentativeInfoResponseDivisions (HashMap Text GeographicDivision)

The unique Open Civic Data identifier for this division.

VoterInfoResponse

data VoterInfoResponse

The result of a voter info lookup query.

See: voterInfoResponse smart constructor.

Instances

Eq VoterInfoResponse

Data VoterInfoResponse

Show VoterInfoResponse

Generic VoterInfoResponse

ToJSON VoterInfoResponse

FromJSON VoterInfoResponse

type Rep VoterInfoResponse

voterInfoResponse :: VoterInfoResponse

Creates a value of VoterInfoResponse with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• virOtherElections
• virContests
• virState
• virKind
• virDropOffLocations
• virElection
• virNormalizedInput
• virMailOnly
• virEarlyVoteSites
• virPollingLocations
• virPrecinctId

virOtherElections :: Lens' VoterInfoResponse [Election]

If no election ID was specified in the query, and there was more than one election with data for the given voter, this will contain information about the other elections that could apply.

virContests :: Lens' VoterInfoResponse [Contest]

Contests that will appear on the voter's ballot.

virState :: Lens' VoterInfoResponse [AdministrationRegion]

Local Election Information for the state that the voter votes in. For the US, there will only be one element in this array.

virKind :: Lens' VoterInfoResponse Text

Identifies what kind of resource this is. Value: the fixed string "civicinfo#voterInfoResponse".

virDropOffLocations :: Lens' VoterInfoResponse [PollingLocation]

Locations where a voter is eligible to drop off a completed ballot. The voter must have received and completed a ballot prior to arriving at the location. The location may not have ballots available on the premises. These locations could be open on or before election day as indicated in the pollingHours field.

virElection :: Lens' VoterInfoResponse (Maybe Election)

The election that was queried.

virNormalizedInput :: Lens' VoterInfoResponse (Maybe SimpleAddressType)

The normalized version of the requested address

virMailOnly :: Lens' VoterInfoResponse (Maybe Bool)

Specifies whether voters in the precinct vote only by mailing their ballots (with the possible option of dropping off their ballots as well).

virEarlyVoteSites :: Lens' VoterInfoResponse [PollingLocation]

Locations where the voter is eligible to vote early, prior to election day.

virPollingLocations :: Lens' VoterInfoResponse [PollingLocation]

Locations where the voter is eligible to vote on election day.

virPrecinctId :: Lens' VoterInfoResponse (Maybe Text)

PollingLocation

data PollingLocation

A location where a voter can vote. This may be an early vote site, an election day voting location, or a drop off location for a completed ballot.

See: pollingLocation smart constructor.

Instances

Eq PollingLocation

Data PollingLocation

Show PollingLocation

Generic PollingLocation

ToJSON PollingLocation

FromJSON PollingLocation

type Rep PollingLocation

pollingLocation :: PollingLocation

Creates a value of PollingLocation with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• plVoterServices
• plEndDate
• plSources
• plAddress
• plStartDate
• plPollingHours
• plName
• plId
• plNotes

plVoterServices :: Lens' PollingLocation (Maybe Text)

The services provided by this early vote site or drop off location. This field is not populated for polling locations.

plEndDate :: Lens' PollingLocation (Maybe Text)

The last date that this early vote site or drop off location may be used. This field is not populated for polling locations.

plSources :: Lens' PollingLocation [Source]

A list of sources for this location. If multiple sources are listed the data has been aggregated from those sources.

plAddress :: Lens' PollingLocation (Maybe SimpleAddressType)

The address of the location.

plStartDate :: Lens' PollingLocation (Maybe Text)

The first date that this early vote site or drop off location may be used. This field is not populated for polling locations.

plPollingHours :: Lens' PollingLocation (Maybe Text)

A description of when this location is open.

plName :: Lens' PollingLocation (Maybe Text)

The name of the early vote site or drop off location. This field is not populated for polling locations.

plId :: Lens' PollingLocation (Maybe Text)

An ID for this object. IDs may change in future requests and should not be cached. Access to this field requires special access that can be requested from the Request more link on the Quotas page.

plNotes :: Lens' PollingLocation (Maybe Text)

Notes about this location (e.g. accessibility ramp or entrance to use).

RepresentativesRepresentativeInfoByDivisionLevels

data RepresentativesRepresentativeInfoByDivisionLevels

A list of office levels to filter by. Only offices that serve at least one of these levels will be returned. Divisions that don't contain a matching office will not be returned.

Constructors

ADMINISTRATIVEAREA1

administrativeArea1

ADMINISTRATIVEAREA2

administrativeArea2

Country

country

International

international

Locality

locality

Regional

regional

Special

special

SUBLOCALITY1

subLocality1

SUBLOCALITY2

subLocality2

Instances

Enum RepresentativesRepresentativeInfoByDivisionLevels

Eq RepresentativesRepresentativeInfoByDivisionLevels

Data RepresentativesRepresentativeInfoByDivisionLevels

Ord RepresentativesRepresentativeInfoByDivisionLevels

Read RepresentativesRepresentativeInfoByDivisionLevels

Show RepresentativesRepresentativeInfoByDivisionLevels

Generic RepresentativesRepresentativeInfoByDivisionLevels

ToJSON RepresentativesRepresentativeInfoByDivisionLevels

FromJSON RepresentativesRepresentativeInfoByDivisionLevels

ToText RepresentativesRepresentativeInfoByDivisionLevels

FromText RepresentativesRepresentativeInfoByDivisionLevels

Hashable RepresentativesRepresentativeInfoByDivisionLevels

type Rep RepresentativesRepresentativeInfoByDivisionLevels

GeographicDivision

data GeographicDivision

Describes a political geography.

See: geographicDivision smart constructor.

Instances

Eq GeographicDivision

Data GeographicDivision

Show GeographicDivision

Generic GeographicDivision

ToJSON GeographicDivision

FromJSON GeographicDivision

type Rep GeographicDivision

geographicDivision :: GeographicDivision

Creates a value of GeographicDivision with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• gdName
• gdOfficeIndices
• gdAlsoKnownAs

gdName :: Lens' GeographicDivision (Maybe Text)

The name of the division.

gdOfficeIndices :: Lens' GeographicDivision [Word32]

List of indices in the offices array, one for each office elected from this division. Will only be present if includeOffices was true (or absent) in the request.

gdAlsoKnownAs :: Lens' GeographicDivision [Text]

Any other valid OCD IDs that refer to the same division. Because OCD IDs are meant to be human-readable and at least somewhat predictable, there are occasionally several identifiers for a single division. These identifiers are defined to be equivalent to one another, and one is always indicated as the primary identifier. The primary identifier will be returned in ocd_id above, and any other equivalent valid identifiers will be returned in this list. For example, if this division's OCD ID is ocd-division/country:us/district:dc, this will contain ocd-division/country:us/state:dc.

Candidate

data Candidate

Information about a candidate running for elected office.

See: candidate smart constructor.

Instances

Eq Candidate

Data Candidate

Show Candidate

Generic Candidate

ToJSON Candidate

FromJSON Candidate

type Rep Candidate

candidate :: Candidate

Creates a value of Candidate with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• cEmail
• cPhone
• cPhotoURL
• cChannels
• cCandidateURL
• cOrderOnBallot
• cName
• cParty

cEmail :: Lens' Candidate (Maybe Text)

The email address for the candidate's campaign.

cPhone :: Lens' Candidate (Maybe Text)

The voice phone number for the candidate's campaign office.

cPhotoURL :: Lens' Candidate (Maybe Text)

A URL for a photo of the candidate.

cChannels :: Lens' Candidate [Channel]

A list of known (social) media channels for this candidate.

cCandidateURL :: Lens' Candidate (Maybe Text)

The URL for the candidate's campaign web site.

cOrderOnBallot :: Lens' Candidate (Maybe Int64)

The order the candidate appears on the ballot for this contest.

cName :: Lens' Candidate (Maybe Text)

The candidate's name.

cParty :: Lens' Candidate (Maybe Text)

The full name of the party the candidate is a member of.

RepresentativesRepresentativeInfoByAddressLevels

data RepresentativesRepresentativeInfoByAddressLevels

A list of office levels to filter by. Only offices that serve at least one of these levels will be returned. Divisions that don't contain a matching office will not be returned.

Constructors

RRIBALADMINISTRATIVEAREA1

administrativeArea1

RRIBALADMINISTRATIVEAREA2

administrativeArea2

RRIBALCountry

country

RRIBALInternational

international

RRIBALLocality

locality

RRIBALRegional

regional

RRIBALSpecial

special

RRIBALSUBLOCALITY1

subLocality1

RRIBALSUBLOCALITY2

subLocality2

Instances

Enum RepresentativesRepresentativeInfoByAddressLevels

Eq RepresentativesRepresentativeInfoByAddressLevels

Data RepresentativesRepresentativeInfoByAddressLevels

Ord RepresentativesRepresentativeInfoByAddressLevels

Read RepresentativesRepresentativeInfoByAddressLevels

Show RepresentativesRepresentativeInfoByAddressLevels

Generic RepresentativesRepresentativeInfoByAddressLevels

ToJSON RepresentativesRepresentativeInfoByAddressLevels

FromJSON RepresentativesRepresentativeInfoByAddressLevels

ToText RepresentativesRepresentativeInfoByAddressLevels

FromText RepresentativesRepresentativeInfoByAddressLevels

Hashable RepresentativesRepresentativeInfoByAddressLevels

type Rep RepresentativesRepresentativeInfoByAddressLevels

Office

data Office

Information about an Office held by one or more Officials.

See: office smart constructor.

Instances

Eq Office

Data Office

Show Office

Generic Office

ToJSON Office

FromJSON Office

type Rep Office

office :: Office

Creates a value of Office with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• oDivisionId
• oRoles
• oOfficialIndices
• oSources
• oName
• oLevels

oDivisionId :: Lens' Office (Maybe Text)

The OCD ID of the division with which this office is associated.

oRoles :: Lens' Office [Text]

The roles which this office fulfills. Roles are not meant to be exhaustive, or to exactly specify the entire set of responsibilities of a given office, but are meant to be rough categories that are useful for general selection from or sorting of a list of offices.

oOfficialIndices :: Lens' Office [Word32]

List of indices in the officials array of people who presently hold this office.

oSources :: Lens' Office [Source]

A list of sources for this office. If multiple sources are listed, the data has been aggregated from those sources.

oName :: Lens' Office (Maybe Text)

The human-readable name of the office.

oLevels :: Lens' Office [Text]

The levels of government of which this office is part. 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".

RepresentativesRepresentativeInfoByDivisionRoles

data RepresentativesRepresentativeInfoByDivisionRoles

A list of office roles to filter by. Only offices fulfilling one of these roles will be returned. Divisions that don't contain a matching office will not be returned.

Constructors

DeputyHeadOfGovernment

deputyHeadOfGovernment

ExecutiveCouncil

executiveCouncil

GovernmentOfficer

governmentOfficer

HeadOfGovernment

headOfGovernment

HeadOfState

headOfState

HighestCourtJudge

highestCourtJudge

Judge

judge

LegislatorLowerBody

legislatorLowerBody

LegislatorUpperBody

legislatorUpperBody

SchoolBoard

schoolBoard

SpecialPurposeOfficer

specialPurposeOfficer

Instances

Enum RepresentativesRepresentativeInfoByDivisionRoles

Eq RepresentativesRepresentativeInfoByDivisionRoles

Data RepresentativesRepresentativeInfoByDivisionRoles

Ord RepresentativesRepresentativeInfoByDivisionRoles

Read RepresentativesRepresentativeInfoByDivisionRoles

Show RepresentativesRepresentativeInfoByDivisionRoles

Generic RepresentativesRepresentativeInfoByDivisionRoles

ToJSON RepresentativesRepresentativeInfoByDivisionRoles

FromJSON RepresentativesRepresentativeInfoByDivisionRoles

ToText RepresentativesRepresentativeInfoByDivisionRoles

FromText RepresentativesRepresentativeInfoByDivisionRoles

Hashable RepresentativesRepresentativeInfoByDivisionRoles

type Rep RepresentativesRepresentativeInfoByDivisionRoles

Channel

data Channel

A social media or web channel for a candidate.

See: channel smart constructor.

Instances

Eq Channel

Data Channel

Show Channel

Generic Channel

ToJSON Channel

FromJSON Channel

type Rep Channel

channel :: Channel

Creates a value of Channel with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• cId
• cType

cId :: Lens' Channel (Maybe Text)

The unique public identifier for the candidate's channel.

cType :: Lens' Channel (Maybe Text)

The type of channel. The following is a list of types of channels, but is not exhaustive. More channel types may be added at a later time. One of: GooglePlus, YouTube, Facebook, Twitter

Election

data Election

Information about the election that was queried.

See: election smart constructor.

Instances

Eq Election

Data Election

Show Election

Generic Election

ToJSON Election

FromJSON Election

type Rep Election

election :: Election

Creates a value of Election with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• eOcdDivisionId
• eElectionDay
• eName
• eId

eOcdDivisionId :: Lens' Election (Maybe Text)

The political division of the election. Represented as an OCD Division ID. Voters within these political jurisdictions are covered by this election. This is typically a state such as ocd-division/country:us/state:ca or for the midterms or general election the entire US (i.e. ocd-division/country:us).

eElectionDay :: Lens' Election (Maybe Text)

Day of the election in YYYY-MM-DD format.

eName :: Lens' Election (Maybe Text)

A displayable name for the election.

eId :: Lens' Election (Maybe Int64)

The unique ID of this election.

RepresentativeInfoResponse

data RepresentativeInfoResponse

The result of a representative info lookup query.

See: representativeInfoResponse smart constructor.

Instances

Eq RepresentativeInfoResponse

Data RepresentativeInfoResponse

Show RepresentativeInfoResponse

Generic RepresentativeInfoResponse

ToJSON RepresentativeInfoResponse

FromJSON RepresentativeInfoResponse

type Rep RepresentativeInfoResponse

representativeInfoResponse :: RepresentativeInfoResponse

Creates a value of RepresentativeInfoResponse with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• rirKind
• rirNormalizedInput
• rirOfficials
• rirDivisions
• rirOffices

rirKind :: Lens' RepresentativeInfoResponse Text

Identifies what kind of resource this is. Value: the fixed string "civicinfo#representativeInfoResponse".

rirNormalizedInput :: Lens' RepresentativeInfoResponse (Maybe SimpleAddressType)

The normalized version of the requested address

rirOfficials :: Lens' RepresentativeInfoResponse [Official]

Officials holding the offices listed above. Will only be present if includeOffices was true in the request.

rirDivisions :: Lens' RepresentativeInfoResponse (Maybe RepresentativeInfoResponseDivisions)

Political geographic divisions that contain the requested address.

rirOffices :: Lens' RepresentativeInfoResponse [Office]

Elected offices referenced by the divisions listed above. Will only be present if includeOffices was true in the request.

DivisionSearchResult

data DivisionSearchResult

Represents a political geographic division that matches the requested query.

See: divisionSearchResult smart constructor.

Instances

Eq DivisionSearchResult

Data DivisionSearchResult

Show DivisionSearchResult

Generic DivisionSearchResult

ToJSON DivisionSearchResult

FromJSON DivisionSearchResult

type Rep DivisionSearchResult

divisionSearchResult :: DivisionSearchResult

Creates a value of DivisionSearchResult with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• dsrAliases
• dsrName
• dsrOcdId

dsrAliases :: Lens' DivisionSearchResult [Text]

Other Open Civic Data identifiers that refer to the same division -- for example, those that refer to other political divisions whose boundaries are defined to be coterminous with this one. For example, ocd-division/country:us/state:wy will include an alias of ocd-division/country:us/state:wy/cd:1, since Wyoming has only one Congressional district.

dsrName :: Lens' DivisionSearchResult (Maybe Text)

The name of the division.

dsrOcdId :: Lens' DivisionSearchResult (Maybe Text)

The unique Open Civic Data identifier for this division.

AdministrativeBody

data AdministrativeBody

Information about an election administrative body (e.g. County Board of Elections).

See: administrativeBody smart constructor.

Instances

Eq AdministrativeBody

Data AdministrativeBody

Show AdministrativeBody

Generic AdministrativeBody

ToJSON AdministrativeBody

FromJSON AdministrativeBody

type Rep AdministrativeBody

administrativeBody :: AdministrativeBody

Creates a value of AdministrativeBody with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• abCorrespondenceAddress
• abAbsenteeVotingInfoURL
• abHoursOfOperation
• abBallotInfoURL
• abPhysicalAddress
• abElectionRegistrationConfirmationURL
• abElectionInfoURL
• abVotingLocationFinderURL
• abElectionOfficials
• abName
• abElectionRulesURL
• abVoterServices
• abElectionRegistrationURL

abCorrespondenceAddress :: Lens' AdministrativeBody (Maybe SimpleAddressType)

The mailing address of this administrative body.

abAbsenteeVotingInfoURL :: Lens' AdministrativeBody (Maybe Text)

A URL provided by this administrative body for information on absentee voting.

abHoursOfOperation :: Lens' AdministrativeBody (Maybe Text)

A description of the hours of operation for this administrative body.

abBallotInfoURL :: Lens' AdministrativeBody (Maybe Text)

A URL provided by this administrative body to give contest information to the voter.

abPhysicalAddress :: Lens' AdministrativeBody (Maybe SimpleAddressType)

The physical address of this administrative body.

abElectionRegistrationConfirmationURL :: Lens' AdministrativeBody (Maybe Text)

A URL provided by this administrative body for confirming that the voter is registered to vote.

abElectionInfoURL :: Lens' AdministrativeBody (Maybe Text)

A URL provided by this administrative body for looking up general election information.

abVotingLocationFinderURL :: Lens' AdministrativeBody (Maybe Text)

A URL provided by this administrative body for looking up where to vote.

abElectionOfficials :: Lens' AdministrativeBody [ElectionOfficial]

The election officials for this election administrative body.

abName :: Lens' AdministrativeBody (Maybe Text)

The name of this election administrative body.

abElectionRulesURL :: Lens' AdministrativeBody (Maybe Text)

A URL provided by this administrative body describing election rules to the voter.

abVoterServices :: Lens' AdministrativeBody [Text]

A description of the services this administrative body may provide.

abElectionRegistrationURL :: Lens' AdministrativeBody (Maybe Text)

A URL provided by this administrative body for looking up how to register to vote.

Contest

data Contest

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

See: contest smart constructor.

Instances

Eq Contest

Data Contest

Show Contest

Generic Contest

ToJSON Contest

FromJSON Contest

type Rep Contest

contest :: Contest

Creates a value of Contest with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• conReferendumPassageThreshold
• conRoles
• conReferendumURL
• conReferendumEffectOfAbstain
• conReferendumSubtitle
• conNumberVotingFor
• conOffice
• conReferendumConStatement
• conSources
• conReferendumProStatement
• conReferendumBallotResponses
• conNumberElected
• conSpecial
• conReferendumText
• conPrimaryParty
• conId
• conType
• conElectorateSpecifications
• conReferendumBrief
• conDistrict
• conLevel
• conCandidates
• conReferendumTitle
• conBallotPlacement

conReferendumPassageThreshold :: Lens' Contest (Maybe Text)

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'.

conRoles :: Lens' Contest [Text]

The roles which this office fulfills.

conReferendumURL :: Lens' Contest (Maybe Text)

A link to the referendum. This field is only populated for contests of type 'Referendum'.

conReferendumEffectOfAbstain :: Lens' Contest (Maybe Text)

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'.

conReferendumSubtitle :: Lens' Contest (Maybe Text)

A brief description of the referendum. This field is only populated for contests of type 'Referendum'.

conNumberVotingFor :: Lens' Contest (Maybe Int64)

The number of candidates that a voter may vote for in this contest.

conOffice :: Lens' Contest (Maybe Text)

The name of the office for this contest.

conReferendumConStatement :: Lens' Contest (Maybe Text)

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'.

conSources :: Lens' Contest [Source]

A list of sources for this contest. If multiple sources are listed, the data has been aggregated from those sources.

conReferendumProStatement :: Lens' Contest (Maybe Text)

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'.

conReferendumBallotResponses :: Lens' Contest [Text]

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, or a judge's name for a retention contest. This field is only populated for contests of type 'Referendum'.

conNumberElected :: Lens' Contest (Maybe Int64)

The number of candidates that will be elected to office in this contest.

conSpecial :: Lens' Contest (Maybe Text)

"Yes" or "No" depending on whether this a contest being held outside the normal election cycle.

conReferendumText :: Lens' Contest (Maybe Text)

The full text of the referendum. This field is only populated for contests of type 'Referendum'.

conPrimaryParty :: Lens' Contest (Maybe Text)

If this is a partisan election, the name of the party it is for.

conId :: Lens' Contest (Maybe Text)

An ID for this object. IDs may change in future requests and should not be cached. Access to this field requires special access that can be requested from the Request more link on the Quotas page.

conType :: Lens' Contest (Maybe Text)

The type of contest. Usually this will be 'General', 'Primary', or 'Run-off' for contests with candidates. For referenda this will be 'Referendum'.

conElectorateSpecifications :: Lens' Contest (Maybe Text)

A description of any additional eligibility requirements for voting in this contest.

conReferendumBrief :: Lens' Contest (Maybe Text)

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'.

conDistrict :: Lens' Contest (Maybe ElectoralDistrict)

Information about the electoral district that this contest is in.

conLevel :: Lens' Contest [Text]

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".

conCandidates :: Lens' Contest [Candidate]

The candidate choices for this contest.

conReferendumTitle :: Lens' Contest (Maybe Text)

The title of the referendum (e.g. 'Proposition 42'). This field is only populated for contests of type 'Referendum'.

conBallotPlacement :: Lens' Contest (Maybe Int64)

A number specifying the position of this contest on the voter's ballot.

DivisionSearchResponse

data DivisionSearchResponse

The result of a division search query.

See: divisionSearchResponse smart constructor.

Instances

Eq DivisionSearchResponse

Data DivisionSearchResponse

Show DivisionSearchResponse

Generic DivisionSearchResponse

ToJSON DivisionSearchResponse

FromJSON DivisionSearchResponse

type Rep DivisionSearchResponse

divisionSearchResponse :: DivisionSearchResponse

Creates a value of DivisionSearchResponse with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• dsrResults
• dsrKind

dsrResults :: Lens' DivisionSearchResponse [DivisionSearchResult]

dsrKind :: Lens' DivisionSearchResponse Text

Identifies what kind of resource this is. Value: the fixed string "civicinfo#divisionSearchResponse".

RepresentativeInfoDataDivisions

data RepresentativeInfoDataDivisions

Political geographic divisions that contain the requested address.

See: representativeInfoDataDivisions smart constructor.

Instances

Eq RepresentativeInfoDataDivisions

Data RepresentativeInfoDataDivisions

Show RepresentativeInfoDataDivisions

Generic RepresentativeInfoDataDivisions

ToJSON RepresentativeInfoDataDivisions

FromJSON RepresentativeInfoDataDivisions

type Rep RepresentativeInfoDataDivisions

representativeInfoDataDivisions

Arguments

:: HashMap Text GeographicDivision

riddAddtional

-> RepresentativeInfoDataDivisions

Creates a value of RepresentativeInfoDataDivisions with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• riddAddtional

riddAddtional :: Lens' RepresentativeInfoDataDivisions (HashMap Text GeographicDivision)

The unique Open Civic Data identifier for this division.

RepresentativesRepresentativeInfoByAddressRoles

data RepresentativesRepresentativeInfoByAddressRoles

A list of office roles to filter by. Only offices fulfilling one of these roles will be returned. Divisions that don't contain a matching office will not be returned.

Constructors

RRIBARDeputyHeadOfGovernment

deputyHeadOfGovernment

RRIBARExecutiveCouncil

executiveCouncil

RRIBARGovernmentOfficer

governmentOfficer

RRIBARHeadOfGovernment

headOfGovernment

RRIBARHeadOfState

headOfState

RRIBARHighestCourtJudge

highestCourtJudge

RRIBARJudge

judge

RRIBARLegislatorLowerBody

legislatorLowerBody

RRIBARLegislatorUpperBody

legislatorUpperBody

RRIBARSchoolBoard

schoolBoard

RRIBARSpecialPurposeOfficer

specialPurposeOfficer

Instances

Enum RepresentativesRepresentativeInfoByAddressRoles

Eq RepresentativesRepresentativeInfoByAddressRoles

Data RepresentativesRepresentativeInfoByAddressRoles

Ord RepresentativesRepresentativeInfoByAddressRoles

Read RepresentativesRepresentativeInfoByAddressRoles

Show RepresentativesRepresentativeInfoByAddressRoles

Generic RepresentativesRepresentativeInfoByAddressRoles

ToJSON RepresentativesRepresentativeInfoByAddressRoles

FromJSON RepresentativesRepresentativeInfoByAddressRoles

ToText RepresentativesRepresentativeInfoByAddressRoles

FromText RepresentativesRepresentativeInfoByAddressRoles

Hashable RepresentativesRepresentativeInfoByAddressRoles

type Rep RepresentativesRepresentativeInfoByAddressRoles

ElectionOfficial

data ElectionOfficial

Information about individual election officials.

See: electionOfficial smart constructor.

Instances

Eq ElectionOfficial

Data ElectionOfficial

Show ElectionOfficial

Generic ElectionOfficial

ToJSON ElectionOfficial

FromJSON ElectionOfficial

type Rep ElectionOfficial

electionOfficial :: ElectionOfficial

Creates a value of ElectionOfficial with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• eoFaxNumber
• eoName
• eoOfficePhoneNumber
• eoEmailAddress
• eoTitle

eoFaxNumber :: Lens' ElectionOfficial (Maybe Text)

The fax number of the election official.

eoName :: Lens' ElectionOfficial (Maybe Text)

The full name of the election official.

eoOfficePhoneNumber :: Lens' ElectionOfficial (Maybe Text)

The office phone number of the election official.

eoEmailAddress :: Lens' ElectionOfficial (Maybe Text)

The email address of the election official.

eoTitle :: Lens' ElectionOfficial (Maybe Text)

The title of the election official.

RepresentativeInfoData

data RepresentativeInfoData

Instances

Eq RepresentativeInfoData

Data RepresentativeInfoData

Show RepresentativeInfoData

Generic RepresentativeInfoData

ToJSON RepresentativeInfoData

FromJSON RepresentativeInfoData

type Rep RepresentativeInfoData

representativeInfoData :: RepresentativeInfoData

Creates a value of RepresentativeInfoData with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• ridOfficials
• ridDivisions
• ridOffices

ridOfficials :: Lens' RepresentativeInfoData [Official]

Officials holding the offices listed above. Will only be present if includeOffices was true in the request.

ridDivisions :: Lens' RepresentativeInfoData (Maybe RepresentativeInfoDataDivisions)

Political geographic divisions that contain the requested address.

ridOffices :: Lens' RepresentativeInfoData [Office]

Elected offices referenced by the divisions listed above. Will only be present if includeOffices was true in the request.

Source

data Source

Contains information about the data source for the element containing it.

See: source smart constructor.

Instances

Eq Source

Data Source

Show Source

Generic Source

ToJSON Source

FromJSON Source

type Rep Source

source :: Source

Creates a value of Source with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• sName
• sOfficial

sName :: Lens' Source (Maybe Text)

The name of the data source.

sOfficial :: Lens' Source (Maybe Bool)

Whether this data comes from an official government source.

ElectoralDistrict

data ElectoralDistrict

Describes the geographic scope of a contest.

See: electoralDistrict smart constructor.

Instances

Eq ElectoralDistrict

Data ElectoralDistrict

Show ElectoralDistrict

Generic ElectoralDistrict

ToJSON ElectoralDistrict

FromJSON ElectoralDistrict

type Rep ElectoralDistrict

electoralDistrict :: ElectoralDistrict

Creates a value of ElectoralDistrict with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• edName
• edScope
• edId

edName :: Lens' ElectoralDistrict (Maybe Text)

The name of the district.

edScope :: Lens' ElectoralDistrict (Maybe Text)

The geographic scope of this district. If unspecified the district's geography is not known. One of: national, statewide, congressional, stateUpper, stateLower, countywide, judicial, schoolBoard, cityWide, township, countyCouncil, cityCouncil, ward, special

edId :: Lens' ElectoralDistrict (Maybe Text)

An identifier for this district, relative to its scope. For example, the 34th State Senate district would have id "34" and a scope of stateUpper.

SimpleAddressType

data SimpleAddressType

A simple representation of an address.

See: simpleAddressType smart constructor.

Instances

Eq SimpleAddressType

Data SimpleAddressType

Show SimpleAddressType

Generic SimpleAddressType

ToJSON SimpleAddressType

FromJSON SimpleAddressType

type Rep SimpleAddressType

simpleAddressType :: SimpleAddressType

Creates a value of SimpleAddressType with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• satLine2
• satState
• satLine3
• satZip
• satCity
• satLine1
• satLocationName

satLine2 :: Lens' SimpleAddressType (Maybe Text)

The second line the address, if needed.

satState :: Lens' SimpleAddressType (Maybe Text)

The US two letter state abbreviation of the address.

satLine3 :: Lens' SimpleAddressType (Maybe Text)

The third line of the address, if needed.

satZip :: Lens' SimpleAddressType (Maybe Text)

The US Postal Zip Code of the address.

satCity :: Lens' SimpleAddressType (Maybe Text)

The city or town for the address.

satLine1 :: Lens' SimpleAddressType (Maybe Text)

The street name and number of this address.

satLocationName :: Lens' SimpleAddressType (Maybe Text)

The name of the location.

AdministrationRegion

data AdministrationRegion

Describes information about a regional election administrative area.

See: administrationRegion smart constructor.

Instances

Eq AdministrationRegion

Data AdministrationRegion

Show AdministrationRegion

Generic AdministrationRegion

ToJSON AdministrationRegion

FromJSON AdministrationRegion

type Rep AdministrationRegion

administrationRegion :: AdministrationRegion

Creates a value of AdministrationRegion with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• arLocalJurisdiction
• arSources
• arName
• arElectionAdministrationBody
• arId

arLocalJurisdiction :: Lens' AdministrationRegion (Maybe AdministrationRegion)

The city or county that provides election information for this voter. This object can have the same elements as state.

arSources :: Lens' AdministrationRegion [Source]

A list of sources for this area. If multiple sources are listed the data has been aggregated from those sources.

arName :: Lens' AdministrationRegion (Maybe Text)

The name of the jurisdiction.

arElectionAdministrationBody :: Lens' AdministrationRegion (Maybe AdministrativeBody)

The election administration body for this area.

arId :: Lens' AdministrationRegion (Maybe Text)

An ID for this object. IDs may change in future requests and should not be cached. Access to this field requires special access that can be requested from the Request more link on the Quotas page.

ElectionsQueryResponse

data ElectionsQueryResponse

The list of elections available for this version of the API.

See: electionsQueryResponse smart constructor.

Instances

Eq ElectionsQueryResponse

Data ElectionsQueryResponse

Show ElectionsQueryResponse

Generic ElectionsQueryResponse

ToJSON ElectionsQueryResponse

FromJSON ElectionsQueryResponse

type Rep ElectionsQueryResponse

electionsQueryResponse :: ElectionsQueryResponse

Creates a value of ElectionsQueryResponse with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• eqrKind
• eqrElections

eqrKind :: Lens' ElectionsQueryResponse Text

Identifies what kind of resource this is. Value: the fixed string "civicinfo#electionsQueryResponse".

eqrElections :: Lens' ElectionsQueryResponse [Election]

A list of available elections

Official

data Official

Information about a person holding an elected office.

See: official smart constructor.

Instances

Eq Official

Data Official

Show Official

Generic Official

ToJSON Official

FromJSON Official

type Rep Official

official :: Official

Creates a value of Official with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• offPhotoURL
• offURLs
• offChannels
• offAddress
• offPhones
• offName
• offEmails
• offParty

offPhotoURL :: Lens' Official (Maybe Text)

A URL for a photo of the official.

offURLs :: Lens' Official [Text]

The official's public website URLs.

offChannels :: Lens' Official [Channel]

A list of known (social) media channels for this official.

offAddress :: Lens' Official [SimpleAddressType]

Addresses at which to contact the official.

offPhones :: Lens' Official [Text]

The official's public contact phone numbers.

offName :: Lens' Official (Maybe Text)

The official's name.

offEmails :: Lens' Official [Text]

The direct email addresses for the official.

offParty :: Lens' Official (Maybe Text)

The full name of the party the official belongs to.