Copyright	(c) 2015-2016 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay <brendan.g.hay@gmail.com>
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	None
Language	Haskell2010

Network.Google.Resource.CivicInfo.Elections.VoterInfoQuery

Contents

REST Resource
Creating a Request
Request Lenses

Description

Looks up information relevant to a voter based on the voter's registered address.

See: Google Civic Information API Reference for civicinfo.elections.voterInfoQuery.

Synopsis

type ElectionsVoterInfoQueryResource = "civicinfo" :> ("v2" :> ("voterinfo" :> (QueryParam "address" Text :> (QueryParam "returnAllAvailableData" Bool :> (QueryParam "electionId" (Textual Int64) :> (QueryParam "officialOnly" Bool :> (QueryParam "alt" AltJSON :> (ReqBody '[JSON] VoterInfoRequest :> Get '[JSON] VoterInfoResponse))))))))
electionsVoterInfoQuery :: Text -> VoterInfoRequest -> ElectionsVoterInfoQuery
data ElectionsVoterInfoQuery
eviqReturnAllAvailableData :: Lens' ElectionsVoterInfoQuery Bool
eviqElectionId :: Lens' ElectionsVoterInfoQuery Int64
eviqAddress :: Lens' ElectionsVoterInfoQuery Text
eviqPayload :: Lens' ElectionsVoterInfoQuery VoterInfoRequest
eviqOfficialOnly :: Lens' ElectionsVoterInfoQuery Bool

REST Resource

type ElectionsVoterInfoQueryResource = "civicinfo" :> ("v2" :> ("voterinfo" :> (QueryParam "address" Text :> (QueryParam "returnAllAvailableData" Bool :> (QueryParam "electionId" (Textual Int64) :> (QueryParam "officialOnly" Bool :> (QueryParam "alt" AltJSON :> (ReqBody '[JSON] VoterInfoRequest :> Get '[JSON] VoterInfoResponse)))))))) Source #

A resource alias for civicinfo.elections.voterInfoQuery method which the ElectionsVoterInfoQuery request conforms to.

Creating a Request

electionsVoterInfoQuery Source #

Arguments

:: Text	`eviqAddress`
-> VoterInfoRequest	`eviqPayload`
-> ElectionsVoterInfoQuery

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

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

data ElectionsVoterInfoQuery Source #

Looks up information relevant to a voter based on the voter's registered address.

See: electionsVoterInfoQuery smart constructor.

Instances

Eq ElectionsVoterInfoQuery Source #
Instance details Defined in Network.Google.Resource.CivicInfo.Elections.VoterInfoQuery Methods (==) :: ElectionsVoterInfoQuery -> ElectionsVoterInfoQuery -> Bool # (/=) :: ElectionsVoterInfoQuery -> ElectionsVoterInfoQuery -> Bool #
Data ElectionsVoterInfoQuery Source #
Instance details Defined in Network.Google.Resource.CivicInfo.Elections.VoterInfoQuery Methods gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> ElectionsVoterInfoQuery -> c ElectionsVoterInfoQuery # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c ElectionsVoterInfoQuery # toConstr :: ElectionsVoterInfoQuery -> Constr # dataTypeOf :: ElectionsVoterInfoQuery -> DataType # dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c ElectionsVoterInfoQuery) # dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c ElectionsVoterInfoQuery) # gmapT :: (forall b. Data b => b -> b) -> ElectionsVoterInfoQuery -> ElectionsVoterInfoQuery # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> ElectionsVoterInfoQuery -> r # gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> ElectionsVoterInfoQuery -> r # gmapQ :: (forall d. Data d => d -> u) -> ElectionsVoterInfoQuery -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> ElectionsVoterInfoQuery -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> ElectionsVoterInfoQuery -> m ElectionsVoterInfoQuery # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> ElectionsVoterInfoQuery -> m ElectionsVoterInfoQuery # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> ElectionsVoterInfoQuery -> m ElectionsVoterInfoQuery #
Show ElectionsVoterInfoQuery Source #
Instance details Defined in Network.Google.Resource.CivicInfo.Elections.VoterInfoQuery Methods showsPrec :: Int -> ElectionsVoterInfoQuery -> ShowS # show :: ElectionsVoterInfoQuery -> String # showList :: [ElectionsVoterInfoQuery] -> ShowS #
Generic ElectionsVoterInfoQuery Source #
Instance details Defined in Network.Google.Resource.CivicInfo.Elections.VoterInfoQuery Associated Types type Rep ElectionsVoterInfoQuery :: Type -> Type # Methods from :: ElectionsVoterInfoQuery -> Rep ElectionsVoterInfoQuery x # to :: Rep ElectionsVoterInfoQuery x -> ElectionsVoterInfoQuery #
GoogleRequest ElectionsVoterInfoQuery Source #
Instance details Defined in Network.Google.Resource.CivicInfo.Elections.VoterInfoQuery Associated Types type Rs ElectionsVoterInfoQuery :: Type # type Scopes ElectionsVoterInfoQuery :: [Symbol] # Methods requestClient :: ElectionsVoterInfoQuery -> GClient (Rs ElectionsVoterInfoQuery) #
type Rep ElectionsVoterInfoQuery Source #
Instance details Defined in Network.Google.Resource.CivicInfo.Elections.VoterInfoQuery type Rep ElectionsVoterInfoQuery = D1 (MetaData "ElectionsVoterInfoQuery" "Network.Google.Resource.CivicInfo.Elections.VoterInfoQuery" "gogol-civicinfo-0.4.0-CFTfG36dFIwG9zqAoJPyhB" False) (C1 (MetaCons "ElectionsVoterInfoQuery'" PrefixI True) ((S1 (MetaSel (Just "_eviqReturnAllAvailableData") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Bool) :: S1 (MetaSel (Just "_eviqElectionId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Textual Int64))) :: (S1 (MetaSel (Just "_eviqAddress") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text) :: (S1 (MetaSel (Just "_eviqPayload") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 VoterInfoRequest) :: S1 (MetaSel (Just "_eviqOfficialOnly") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Bool)))))
type Scopes ElectionsVoterInfoQuery Source #
Instance details Defined in Network.Google.Resource.CivicInfo.Elections.VoterInfoQuery type Scopes ElectionsVoterInfoQuery = ([] :: [Symbol])
type Rs ElectionsVoterInfoQuery Source #
Instance details Defined in Network.Google.Resource.CivicInfo.Elections.VoterInfoQuery type Rs ElectionsVoterInfoQuery = VoterInfoResponse

Request Lenses

eviqReturnAllAvailableData :: Lens' ElectionsVoterInfoQuery Bool Source #

If set to true, the query will return the success codeand include any partial information when it is unable to determine a matching address or unable to determine the election for electionId=0 queries.

eviqElectionId :: Lens' ElectionsVoterInfoQuery Int64 Source #

The unique ID of the election to look up. A list of election IDs can be obtained at https://www.googleapis.com/civicinfo/{version}/electionsIf no election ID is specified in the query and there is more than one election with data for the given voter, the additional elections are provided in the otherElections response field.

eviqAddress :: Lens' ElectionsVoterInfoQuery Text Source #

The registered address of the voter to look up.

eviqPayload :: Lens' ElectionsVoterInfoQuery VoterInfoRequest Source #

Multipart request metadata.

eviqOfficialOnly :: Lens' ElectionsVoterInfoQuery Bool Source #

If set to true, only data from official state sources will be returned.