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.Representatives.RepresentativeInfoByDivision

Contents

REST Resource
Creating a Request
Request Lenses

Description

Looks up representative information for a single geographic division.

See: Google Civic Information API Reference for civicinfo.representatives.representativeInfoByDivision.

Synopsis

type RepresentativesRepresentativeInfoByDivisionResource = "civicinfo" :> ("v2" :> ("representatives" :> (Capture "ocdId" Text :> (QueryParams "roles" RepresentativesRepresentativeInfoByDivisionRoles :> (QueryParam "recursive" Bool :> (QueryParams "levels" RepresentativesRepresentativeInfoByDivisionLevels :> (QueryParam "alt" AltJSON :> (ReqBody '[JSON] DivisionRepresentativeInfoRequest :> Get '[JSON] RepresentativeInfoData))))))))
representativesRepresentativeInfoByDivision :: DivisionRepresentativeInfoRequest -> Text -> RepresentativesRepresentativeInfoByDivision
data RepresentativesRepresentativeInfoByDivision
rribdRoles :: Lens' RepresentativesRepresentativeInfoByDivision [RepresentativesRepresentativeInfoByDivisionRoles]
rribdPayload :: Lens' RepresentativesRepresentativeInfoByDivision DivisionRepresentativeInfoRequest
rribdRecursive :: Lens' RepresentativesRepresentativeInfoByDivision (Maybe Bool)
rribdOcdId :: Lens' RepresentativesRepresentativeInfoByDivision Text
rribdLevels :: Lens' RepresentativesRepresentativeInfoByDivision [RepresentativesRepresentativeInfoByDivisionLevels]

REST Resource

type RepresentativesRepresentativeInfoByDivisionResource = "civicinfo" :> ("v2" :> ("representatives" :> (Capture "ocdId" Text :> (QueryParams "roles" RepresentativesRepresentativeInfoByDivisionRoles :> (QueryParam "recursive" Bool :> (QueryParams "levels" RepresentativesRepresentativeInfoByDivisionLevels :> (QueryParam "alt" AltJSON :> (ReqBody '[JSON] DivisionRepresentativeInfoRequest :> Get '[JSON] RepresentativeInfoData)))))))) Source #

A resource alias for civicinfo.representatives.representativeInfoByDivision method which the RepresentativesRepresentativeInfoByDivision request conforms to.

Creating a Request

representativesRepresentativeInfoByDivision Source #

Arguments

:: DivisionRepresentativeInfoRequest	`rribdPayload`
-> Text	`rribdOcdId`
-> RepresentativesRepresentativeInfoByDivision

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

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

data RepresentativesRepresentativeInfoByDivision Source #

Looks up representative information for a single geographic division.

See: representativesRepresentativeInfoByDivision smart constructor.

Instances

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

Request Lenses

rribdRoles :: Lens' RepresentativesRepresentativeInfoByDivision [RepresentativesRepresentativeInfoByDivisionRoles] Source #

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.

rribdPayload :: Lens' RepresentativesRepresentativeInfoByDivision DivisionRepresentativeInfoRequest Source #

Multipart request metadata.

rribdRecursive :: Lens' RepresentativesRepresentativeInfoByDivision (Maybe Bool) Source #

If true, information about all divisions contained in the division requested will be included as well. For example, if querying ocd-division/country:us/district:dc, this would also return all DC's wards and ANCs.

rribdOcdId :: Lens' RepresentativesRepresentativeInfoByDivision Text Source #

The Open Civic Data division identifier of the division to look up.

rribdLevels :: Lens' RepresentativesRepresentativeInfoByDivision [RepresentativesRepresentativeInfoByDivisionLevels] Source #

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.