Data.EBird.API.Product

Types related to eBird product API values.

Top 100 contributors API types

data Top100ListEntry

Values held in the top 100 contributors list returned by the eBird API.

Constructors

Top100ListEntry

Fields

• _top100ListEntryProfileHandle :: Maybe Text

  The profile handle of the user, whocse profile may be seen at ebird.orgprofile{handle} if they have a profile

• _top100ListEntryUserDisplayName :: Text

  The display name of the user (typically their full name)

• _top100ListEntryNumSpecies :: Integer

  The number of species the user observed on the date

• _top100ListEntryNumCompleteChecklists :: Integer

  The number of complete checklists the user contributed on the date

• _top100ListEntryRowNum :: Integer

  The ranking of the user

• _top100ListEntryUserId :: Text

  The user ID od the user

Instances

Read Top100ListEntry

Defined in Data.EBird.API.Product

Methods

readsPrec :: Int -> ReadS Top100ListEntry

readList :: ReadS [Top100ListEntry]

readPrec :: ReadPrec Top100ListEntry

readListPrec :: ReadPrec [Top100ListEntry]

Show Top100ListEntry

Defined in Data.EBird.API.Product

Methods

showsPrec :: Int -> Top100ListEntry -> ShowS

show :: Top100ListEntry -> String

showList :: [Top100ListEntry] -> ShowS

Eq Top100ListEntry

Defined in Data.EBird.API.Product

Methods

(==) :: Top100ListEntry -> Top100ListEntry -> Bool

(/=) :: Top100ListEntry -> Top100ListEntry -> Bool

FromJSON Top100ListEntry

Explicit instance for compatibility with their field names

Defined in Data.EBird.API.Product

Methods

parseJSON :: Value -> Parser Top100ListEntry

parseJSONList :: Value -> Parser [Top100ListEntry]

ToJSON Top100ListEntry

Explicit instance for compatibility with their field names

Defined in Data.EBird.API.Product

Methods

toJSON :: Top100ListEntry -> Value

toEncoding :: Top100ListEntry -> Encoding

toJSONList :: [Top100ListEntry] -> Value

toEncodingList :: [Top100ListEntry] -> Encoding

(k ~ A_Lens, a ~ Integer, b ~ Integer) => LabelOptic "numCompleteChecklists" k Top100ListEntry Top100ListEntry a b

Defined in Data.EBird.API.Product

Methods

labelOptic :: Optic k NoIx Top100ListEntry Top100ListEntry a b

(k ~ A_Lens, a ~ Integer, b ~ Integer) => LabelOptic "numSpecies" k Top100ListEntry Top100ListEntry a b

Defined in Data.EBird.API.Product

Methods

labelOptic :: Optic k NoIx Top100ListEntry Top100ListEntry a b

(k ~ A_Lens, a ~ Maybe Text, b ~ Maybe Text) => LabelOptic "profileHandle" k Top100ListEntry Top100ListEntry a b

Defined in Data.EBird.API.Product

Methods

labelOptic :: Optic k NoIx Top100ListEntry Top100ListEntry a b

(k ~ A_Lens, a ~ Integer, b ~ Integer) => LabelOptic "rowNum" k Top100ListEntry Top100ListEntry a b

Defined in Data.EBird.API.Product

Methods

labelOptic :: Optic k NoIx Top100ListEntry Top100ListEntry a b

(k ~ A_Lens, a ~ Text, b ~ Text) => LabelOptic "userDisplayName" k Top100ListEntry Top100ListEntry a b

Defined in Data.EBird.API.Product

Methods

labelOptic :: Optic k NoIx Top100ListEntry Top100ListEntry a b

(k ~ A_Lens, a ~ Text, b ~ Text) => LabelOptic "userId" k Top100ListEntry Top100ListEntry a b

Defined in Data.EBird.API.Product

Methods

labelOptic :: Optic k NoIx Top100ListEntry Top100ListEntry a b

Optics for the Top100ListEntry type

top100ListEntryUserId :: Lens' Top100ListEntry Text

top100ListEntryUserDisplayName :: Lens' Top100ListEntry Text

top100ListEntryRowNum :: Lens' Top100ListEntry Integer

top100ListEntryProfileHandle :: Lens' Top100ListEntry (Maybe Text)

top100ListEntryNumSpecies :: Lens' Top100ListEntry Integer

top100ListEntryNumCompleteChecklists :: Lens' Top100ListEntry Integer

data RankTop100By

How to rank the list returned by the Top100API.

Constructors

RankTop100BySpecies

Rank the list by the number of species seen

RankTop100ByChecklists

Rank the list by number of contributed checklists

Instances

IsString RankTop100By

Use this instance carefully! It throws runtime exceptions if the string is malformatted.

Defined in Data.EBird.API.Product

Methods

fromString :: String -> RankTop100By

Read RankTop100By

Defined in Data.EBird.API.Product

Methods

readsPrec :: Int -> ReadS RankTop100By

readList :: ReadS [RankTop100By]

readPrec :: ReadPrec RankTop100By

readListPrec :: ReadPrec [RankTop100By]

Show RankTop100By

Defined in Data.EBird.API.Product

Methods

showsPrec :: Int -> RankTop100By -> ShowS

show :: RankTop100By -> String

showList :: [RankTop100By] -> ShowS

EBirdString RankTop100By

The eBird string for a RankTop100By value is either "spp" or "cl".

Defined in Data.EBird.API.Product

Methods

toEBirdString :: RankTop100By -> Text

fromEBirdString :: Text -> Either Text RankTop100By

Eq RankTop100By

Defined in Data.EBird.API.Product

Methods

(==) :: RankTop100By -> RankTop100By -> Bool

(/=) :: RankTop100By -> RankTop100By -> Bool

ToHttpApiData RankTop100By

Defined in Data.EBird.API.Product

Methods

toUrlPiece :: RankTop100By -> Text

toEncodedUrlPiece :: RankTop100By -> Builder

toHeader :: RankTop100By -> ByteString

toQueryParam :: RankTop100By -> Text

toEncodedQueryParam :: RankTop100By -> Builder

Regional statistics API types

data RegionalStatistics

Values returned by the RegionalStatisticsAPI.

Constructors

RegionalStatistics

Fields

• _regionalStatisticsNumChecklists :: Integer

  Number of checklists submitted in the region

• _regionalStatisticsNumContributors :: Integer

  Number of contributors who have submitted checklists in the region

• _regionalStatisticsNumSpecies :: Integer

  Number of species included in checklists in the region

Instances

Read RegionalStatistics

Defined in Data.EBird.API.Product

Methods

readsPrec :: Int -> ReadS RegionalStatistics

readList :: ReadS [RegionalStatistics]

readPrec :: ReadPrec RegionalStatistics

readListPrec :: ReadPrec [RegionalStatistics]

Show RegionalStatistics

Defined in Data.EBird.API.Product

Methods

showsPrec :: Int -> RegionalStatistics -> ShowS

show :: RegionalStatistics -> String

showList :: [RegionalStatistics] -> ShowS

Eq RegionalStatistics

Defined in Data.EBird.API.Product

Methods

(==) :: RegionalStatistics -> RegionalStatistics -> Bool

(/=) :: RegionalStatistics -> RegionalStatistics -> Bool

FromJSON RegionalStatistics

Explicit instance for compatibility with their field names

Defined in Data.EBird.API.Product

Methods

parseJSON :: Value -> Parser RegionalStatistics

parseJSONList :: Value -> Parser [RegionalStatistics]

ToJSON RegionalStatistics

Explicit instance for compatibility with their field names

Defined in Data.EBird.API.Product

Methods

toJSON :: RegionalStatistics -> Value

toEncoding :: RegionalStatistics -> Encoding

toJSONList :: [RegionalStatistics] -> Value

toEncodingList :: [RegionalStatistics] -> Encoding

(k ~ A_Lens, a ~ Integer, b ~ Integer) => LabelOptic "numChecklists" k RegionalStatistics RegionalStatistics a b

Defined in Data.EBird.API.Product

Methods

labelOptic :: Optic k NoIx RegionalStatistics RegionalStatistics a b

(k ~ A_Lens, a ~ Integer, b ~ Integer) => LabelOptic "numContributors" k RegionalStatistics RegionalStatistics a b

Defined in Data.EBird.API.Product

Methods

labelOptic :: Optic k NoIx RegionalStatistics RegionalStatistics a b

(k ~ A_Lens, a ~ Integer, b ~ Integer) => LabelOptic "numSpecies" k RegionalStatistics RegionalStatistics a b

Defined in Data.EBird.API.Product

Methods

labelOptic :: Optic k NoIx RegionalStatistics RegionalStatistics a b

Optics for the RegionalStatistics type

regionalStatisticsNumSpecies :: Lens' RegionalStatistics Integer

regionalStatisticsNumContributors :: Lens' RegionalStatistics Integer

regionalStatisticsNumChecklists :: Lens' RegionalStatistics Integer

attoparsec parsers

parseRankTop100By :: Parser RankTop100By

Parse a RankTop100By value