Data.EBird.API.Taxonomy

Types related to eBird taxonomy-related API values.

Taxonomy types

data Taxon

Taxa in the eBird taxonomy.

Constructors

Taxon

Fields

• _taxonScientificName :: Text

  Scientific name, e.g. "Bombycilla garrulus/cedrorum"

• _taxonCommonName :: Text

  Common name, e.g. "Bohemian/Cedar Waxwing"

• _taxonSpeciesCode :: SpeciesCode

  eBird species code, e.g. "waxwin"

• _taxonCategory :: TaxonomyCategory

  eBird species category, e.g. "slash"

  See the eBird documentation for more information on species categories

• _taxonTaxonOrder :: Double

  A numeric value that determines the location of this taxon in the taxonomy list, e.g. 29257.0

• _taxonBandingCodes :: [Text]

  Banding codes, e.g. ["BOWA"] for Bohemian Waxwing.

• _taxonCommonNameCodes :: [Text]

  Common name codes, e.g. ["BOWA","CEDW","CEWA"]

• _taxonScientificNameCodes :: [Text]

  Scientific name codes, e.g. ["BOCE","BOGA"]

• _taxonOrder :: Text

  Order, e.g. "Passeriformes"

• _taxonFamilyCode :: Maybe Text

  Family code, e.g. "bombyc1"

• _taxonFamilyCommonName :: Maybe Text

  Family common name, e.g. "Waxwings"

• _taxonFamilyScientificName :: Maybe Text

  Family scientific name, e.g. "Bombycillidae"

Instances

Read Taxon

Defined in Data.EBird.API.Taxonomy

Methods

readsPrec :: Int -> ReadS Taxon

readList :: ReadS [Taxon]

readPrec :: ReadPrec Taxon

readListPrec :: ReadPrec [Taxon]

Show Taxon

Defined in Data.EBird.API.Taxonomy

Methods

showsPrec :: Int -> Taxon -> ShowS

show :: Taxon -> String

showList :: [Taxon] -> ShowS

Eq Taxon

Defined in Data.EBird.API.Taxonomy

Methods

(==) :: Taxon -> Taxon -> Bool

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

FromJSON Taxon

Explicit instance for compatibility with their field names

Defined in Data.EBird.API.Taxonomy

Methods

parseJSON :: Value -> Parser Taxon

parseJSONList :: Value -> Parser [Taxon]

ToJSON Taxon

Explicit instance for compatibility with their field names

Defined in Data.EBird.API.Taxonomy

Methods

toJSON :: Taxon -> Value

toEncoding :: Taxon -> Encoding

toJSONList :: [Taxon] -> Value

toEncodingList :: [Taxon] -> Encoding

(k ~ A_Lens, a ~ [Text], b ~ [Text]) => LabelOptic "bandingCodes" k Taxon Taxon a b

Defined in Data.EBird.API.Taxonomy

Methods

labelOptic :: Optic k NoIx Taxon Taxon a b

(k ~ A_Lens, a ~ TaxonomyCategory, b ~ TaxonomyCategory) => LabelOptic "category" k Taxon Taxon a b

Defined in Data.EBird.API.Taxonomy

Methods

labelOptic :: Optic k NoIx Taxon Taxon a b

(k ~ A_Lens, a ~ Text, b ~ Text) => LabelOptic "commonName" k Taxon Taxon a b

Defined in Data.EBird.API.Taxonomy

Methods

labelOptic :: Optic k NoIx Taxon Taxon a b

(k ~ A_Lens, a ~ [Text], b ~ [Text]) => LabelOptic "commonNameCodes" k Taxon Taxon a b

Defined in Data.EBird.API.Taxonomy

Methods

labelOptic :: Optic k NoIx Taxon Taxon a b

(k ~ A_Lens, a ~ Maybe Text, b ~ Maybe Text) => LabelOptic "familyCode" k Taxon Taxon a b

Defined in Data.EBird.API.Taxonomy

Methods

labelOptic :: Optic k NoIx Taxon Taxon a b

(k ~ A_Lens, a ~ Maybe Text, b ~ Maybe Text) => LabelOptic "familyCommonName" k Taxon Taxon a b

Defined in Data.EBird.API.Taxonomy

Methods

labelOptic :: Optic k NoIx Taxon Taxon a b

(k ~ A_Lens, a ~ Maybe Text, b ~ Maybe Text) => LabelOptic "familyScientificName" k Taxon Taxon a b

Defined in Data.EBird.API.Taxonomy

Methods

labelOptic :: Optic k NoIx Taxon Taxon a b

(k ~ A_Lens, a ~ Text, b ~ Text) => LabelOptic "order" k Taxon Taxon a b

Defined in Data.EBird.API.Taxonomy

Methods

labelOptic :: Optic k NoIx Taxon Taxon a b

(k ~ A_Lens, a ~ Text, b ~ Text) => LabelOptic "scientificName" k Taxon Taxon a b

Defined in Data.EBird.API.Taxonomy

Methods

labelOptic :: Optic k NoIx Taxon Taxon a b

(k ~ A_Lens, a ~ [Text], b ~ [Text]) => LabelOptic "scientificNameCodes" k Taxon Taxon a b

Defined in Data.EBird.API.Taxonomy

Methods

labelOptic :: Optic k NoIx Taxon Taxon a b

(k ~ A_Lens, a ~ SpeciesCode, b ~ SpeciesCode) => LabelOptic "speciesCode" k Taxon Taxon a b

Defined in Data.EBird.API.Taxonomy

Methods

labelOptic :: Optic k NoIx Taxon Taxon a b

(k ~ A_Lens, a ~ Double, b ~ Double) => LabelOptic "taxonOrder" k Taxon Taxon a b

Defined in Data.EBird.API.Taxonomy

Methods

labelOptic :: Optic k NoIx Taxon Taxon a b

newtype SpeciesCode

eBird species codes, simply Text; e.g. Gray Vireo is "gryvir", Field Sparrow is "fiespa".

Constructors

SpeciesCode

Fields

• speciesCode :: Text

Instances

IsString SpeciesCode

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

Defined in Data.EBird.API.Taxonomy

Methods

fromString :: String -> SpeciesCode

Read SpeciesCode

Defined in Data.EBird.API.Taxonomy

Methods

readsPrec :: Int -> ReadS SpeciesCode

readList :: ReadS [SpeciesCode]

readPrec :: ReadPrec SpeciesCode

readListPrec :: ReadPrec [SpeciesCode]

Show SpeciesCode

Defined in Data.EBird.API.Taxonomy

Methods

showsPrec :: Int -> SpeciesCode -> ShowS

show :: SpeciesCode -> String

showList :: [SpeciesCode] -> ShowS

EBirdString SpeciesCode

The eBird string of a SpeciesCode is simply the literal string

Defined in Data.EBird.API.Taxonomy

Methods

toEBirdString :: SpeciesCode -> Text

fromEBirdString :: Text -> Either Text SpeciesCode

Eq SpeciesCode

Defined in Data.EBird.API.Taxonomy

Methods

(==) :: SpeciesCode -> SpeciesCode -> Bool

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

ToHttpApiData SpeciesCode

Defined in Data.EBird.API.Taxonomy

Methods

toUrlPiece :: SpeciesCode -> Text

toEncodedUrlPiece :: SpeciesCode -> Builder

toHeader :: SpeciesCode -> ByteString

toQueryParam :: SpeciesCode -> Text

toEncodedQueryParam :: SpeciesCode -> Builder

FromJSON SpeciesCode

Defined in Data.EBird.API.Taxonomy

Methods

parseJSON :: Value -> Parser SpeciesCode

parseJSONList :: Value -> Parser [SpeciesCode]

ToJSON SpeciesCode

Defined in Data.EBird.API.Taxonomy

Methods

toJSON :: SpeciesCode -> Value

toEncoding :: SpeciesCode -> Encoding

toJSONList :: [SpeciesCode] -> Value

toEncodingList :: [SpeciesCode] -> Encoding

newtype SpeciesCodes

A list of eBird SpeciesCodes.

Constructors

SpeciesCodes

Fields

• speciesCodes :: [SpeciesCode]

Instances

IsString SpeciesCodes

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

Defined in Data.EBird.API.Taxonomy

Methods

fromString :: String -> SpeciesCodes

Read SpeciesCodes

Defined in Data.EBird.API.Taxonomy

Methods

readsPrec :: Int -> ReadS SpeciesCodes

readList :: ReadS [SpeciesCodes]

readPrec :: ReadPrec SpeciesCodes

readListPrec :: ReadPrec [SpeciesCodes]

Show SpeciesCodes

Defined in Data.EBird.API.Taxonomy

Methods

showsPrec :: Int -> SpeciesCodes -> ShowS

show :: SpeciesCodes -> String

showList :: [SpeciesCodes] -> ShowS

EBirdString SpeciesCodes

The eBird string of a SpeciesCodes is simply the comma-separated SpeciesCodes

Defined in Data.EBird.API.Taxonomy

Methods

toEBirdString :: SpeciesCodes -> Text

fromEBirdString :: Text -> Either Text SpeciesCodes

Eq SpeciesCodes

Defined in Data.EBird.API.Taxonomy

Methods

(==) :: SpeciesCodes -> SpeciesCodes -> Bool

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

ToHttpApiData SpeciesCodes

Defined in Data.EBird.API.Taxonomy

Methods

toUrlPiece :: SpeciesCodes -> Text

toEncodedUrlPiece :: SpeciesCodes -> Builder

toHeader :: SpeciesCodes -> ByteString

toQueryParam :: SpeciesCodes -> Text

toEncodedQueryParam :: SpeciesCodes -> Builder

FromJSON SpeciesCodes

Defined in Data.EBird.API.Taxonomy

Methods

parseJSON :: Value -> Parser SpeciesCodes

parseJSONList :: Value -> Parser [SpeciesCodes]

ToJSON SpeciesCodes

Defined in Data.EBird.API.Taxonomy

Methods

toJSON :: SpeciesCodes -> Value

toEncoding :: SpeciesCodes -> Encoding

toJSONList :: [SpeciesCodes] -> Value

toEncodingList :: [SpeciesCodes] -> Encoding

data TaxonomyCategory

The taxonomy categories are explained in the eBird documentation. Their examples are echoed in the documentation of the constructors of this type.

Constructors

Species

The Species category simply identifies species, e.g. "Tundra Swan Cygnus columbianus"

Spuh

Genus or broad identification, e.g. "swan sp. Cygnus sp."

ISSF

Identifiable subspecies or group of subspecies, e.g. "Tundra Swan (Bewick’s) Cygnus columbianus bewickii" or "Tundra Swan (Whistling) Cygnus columbianus columbianus"

Slash

Identification to species pair, e.g. "Tundra/Trumpeter Swan Cygnus columbianus/buccinator"

Hybrid

Hybrid between two species, e.g. "Tundra x Trumpeter Swan (hybrid)"

Intergrade

Hybrid between two ISSF (subspecies or subspecies groups), e.g. "Tundra Swan (Whistling x Bewick’s) Cygnus columbianus columbianus x bewickii"

Domestic

Distinctly-plumaged domesticated varieties that may be free-flying (these do not count on personal lists), e.g. "Mallard (Domestic type)"

Form

Miscellaneous other taxa, including recently-described species yet to be accepted or distinctive forms that are not universally accepted, e.g. Red-tailed Hawk (abieticola), Upland Goose (Bar-breasted).

Instances

IsString TaxonomyCategory

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

Defined in Data.EBird.API.Taxonomy

Methods

fromString :: String -> TaxonomyCategory

Read TaxonomyCategory

Defined in Data.EBird.API.Taxonomy

Methods

readsPrec :: Int -> ReadS TaxonomyCategory

readList :: ReadS [TaxonomyCategory]

readPrec :: ReadPrec TaxonomyCategory

readListPrec :: ReadPrec [TaxonomyCategory]

Show TaxonomyCategory

Defined in Data.EBird.API.Taxonomy

Methods

showsPrec :: Int -> TaxonomyCategory -> ShowS

show :: TaxonomyCategory -> String

showList :: [TaxonomyCategory] -> ShowS

EBirdString TaxonomyCategory

The eBird strings of the taxonomy categories are simply the lowercase constructor names.

Defined in Data.EBird.API.Taxonomy

Methods

toEBirdString :: TaxonomyCategory -> Text

fromEBirdString :: Text -> Either Text TaxonomyCategory

Eq TaxonomyCategory

Defined in Data.EBird.API.Taxonomy

Methods

(==) :: TaxonomyCategory -> TaxonomyCategory -> Bool

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

FromJSON TaxonomyCategory

Defined in Data.EBird.API.Taxonomy

Methods

parseJSON :: Value -> Parser TaxonomyCategory

parseJSONList :: Value -> Parser [TaxonomyCategory]

ToJSON TaxonomyCategory

Defined in Data.EBird.API.Taxonomy

Methods

toJSON :: TaxonomyCategory -> Value

toEncoding :: TaxonomyCategory -> Encoding

toJSONList :: [TaxonomyCategory] -> Value

toEncodingList :: [TaxonomyCategory] -> Encoding

newtype TaxonomyCategories

TaxonomyCategories values contain a NonEmpty list of TaxonomyCategorys.

Constructors

TaxonomyCategories

Fields

• taxonomyCategoriesCategories :: NonEmpty TaxonomyCategory

Instances

IsString TaxonomyCategories

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

Defined in Data.EBird.API.Taxonomy

Methods

fromString :: String -> TaxonomyCategories

Read TaxonomyCategories

Defined in Data.EBird.API.Taxonomy

Methods

readsPrec :: Int -> ReadS TaxonomyCategories

readList :: ReadS [TaxonomyCategories]

readPrec :: ReadPrec TaxonomyCategories

readListPrec :: ReadPrec [TaxonomyCategories]

Show TaxonomyCategories

Defined in Data.EBird.API.Taxonomy

Methods

showsPrec :: Int -> TaxonomyCategories -> ShowS

show :: TaxonomyCategories -> String

showList :: [TaxonomyCategories] -> ShowS

EBirdString TaxonomyCategories

The eBird string of a TaxonomyCategories is the comma-separated list of category strings.

Defined in Data.EBird.API.Taxonomy

Methods

toEBirdString :: TaxonomyCategories -> Text

fromEBirdString :: Text -> Either Text TaxonomyCategories

Eq TaxonomyCategories

Defined in Data.EBird.API.Taxonomy

Methods

(==) :: TaxonomyCategories -> TaxonomyCategories -> Bool

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

ToHttpApiData TaxonomyCategories

Defined in Data.EBird.API.Taxonomy

Methods

toUrlPiece :: TaxonomyCategories -> Text

toEncodedUrlPiece :: TaxonomyCategories -> Builder

toHeader :: TaxonomyCategories -> ByteString

toQueryParam :: TaxonomyCategories -> Text

toEncodedQueryParam :: TaxonomyCategories -> Builder

Optics for taxonomy types

taxonTaxonOrder :: Lens' Taxon Double

taxonSpeciesCode :: Lens' Taxon SpeciesCode

taxonScientificNameCodes :: Lens' Taxon [Text]

taxonScientificName :: Lens' Taxon Text

taxonOrder :: Lens' Taxon Text

taxonFamilyScientificName :: Lens' Taxon (Maybe Text)

taxonFamilyCommonName :: Lens' Taxon (Maybe Text)

taxonFamilyCode :: Lens' Taxon (Maybe Text)

taxonCommonNameCodes :: Lens' Taxon [Text]

taxonCommonName :: Lens' Taxon Text

taxonCategory :: Lens' Taxon TaxonomyCategory

taxonBandingCodes :: Lens' Taxon [Text]

Auxiliary eBird taxonomy-related API types

data SPPLocale

eBird maintains many common name translations. See their "Bird Names in eBird" documentation for a discussion of the languages they support.

This type is an enumeration of those languages, and is used to support the eBird API endpoints which allow a locale to be specified.

Constructors

Af

Afrikaans

Sq

Albanians

Ar

Arabic

Hy

Armenian

As

Assamese

Ast

Asturian

Az

Azerbaijani

Eu

Basque

Bn

Bengali

Bg

Bulgarian

Ca

Catalan

Zh

Chinese, Mandarin (traditional)

Zh_SIM

Chinese, Simple

Ht_HT

Creole, Haiti

Hr

Croatian

Cs

Czech

Da

Danish

Nl

Dutch

En

English

En_AU

English, Australia

En_BD

English, Bangladesh

En_HAW

English, Hawaii

En_HBW

English, HBW

En_IN

English, India

En_IOC

English, IOC

En_KE

English, Kenya

En_MY

English, Malaysia

En_NZ

English, New Zealand

En_PH

English, Philippines

En_ZA

English, South Africa

En_AE

English, UAE

En_UK

English, United Kingdon

En_US

English, United States

Fo

Faroese

Fi

Finnish

Fr

French

Fr_AOU

French, AOU

Fr_FR

French, France

Fr_CA

French, Canada

Fr_GF

French, Guiana

Fr_GP

French, Guadeloupe

Fr_HT

French, Haiti

Gl

Gallegan

De

German

El

Greek

Gu

Gujarati

He

Hebrew

Hi

Hindi

Hu

Hungarian

Is

Icelandic

In

Indonesian

It

Italian

Ja

Japanese

Ko

Korean

Lv

Latvian

Lt

Lithuanian

Ml

Malayalam

Mr

Marathi

Mn

Mongolian

No

Norwegian

Or

Odia

Fa

Persian

Pl

Polish

Pt_AO

Portuguese, Angola

Pt_RAA

Portuguese, Azores

Pt_Br

Portuguese, Brazil

Pt_RAM

Portuguese, Madeira

Pt_PT

Portuguese, Portugal

Ro

Romanian

Ru

Russian

Sr

Serbian

Sk

Slovak

Sl

Slovenian

Es

Spanish

Es_AR

Spanish, Argentina

Es_CL

Spanish, Chile

Es_CR

Spanish, Costa Rica

Es_CU

Spanish, Cuba

Es_DO

Spanish, Dominican Republic

Es_EC

Spanish, Ecuador

Es_HN

Spanish, Honduras

Es_MX

Spanish, Mexico

Es_PA

Spanish, Panama

Es_PY

Spanish, Paraguay

Es_PE

Spanish, Peru

Es_PR

Spanish, Puerto Rico

Es_ES

Spanish, Spain

Es_UY

Spanish, Uruguay

Es_VE

Spanish, Venezuela

Sv

Swedish

Te

Telugu

Th

Thai

Tr

Turkish

Uk

Ukrainian

Instances

IsString SPPLocale

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

Defined in Data.EBird.API.Taxonomy

Methods

fromString :: String -> SPPLocale

Read SPPLocale

Defined in Data.EBird.API.Taxonomy

Methods

readsPrec :: Int -> ReadS SPPLocale

readList :: ReadS [SPPLocale]

readPrec :: ReadPrec SPPLocale

readListPrec :: ReadPrec [SPPLocale]

Show SPPLocale

Defined in Data.EBird.API.Taxonomy

Methods

showsPrec :: Int -> SPPLocale -> ShowS

show :: SPPLocale -> String

showList :: [SPPLocale] -> ShowS

EBirdString SPPLocale

The eBird strings of the species locales are simply the lowercase constructor names.

Defined in Data.EBird.API.Taxonomy

Methods

toEBirdString :: SPPLocale -> Text

fromEBirdString :: Text -> Either Text SPPLocale

Eq SPPLocale

Defined in Data.EBird.API.Taxonomy

Methods

(==) :: SPPLocale -> SPPLocale -> Bool

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

ToHttpApiData SPPLocale

Defined in Data.EBird.API.Taxonomy

Methods

toUrlPiece :: SPPLocale -> Text

toEncodedUrlPiece :: SPPLocale -> Builder

toHeader :: SPPLocale -> ByteString

toQueryParam :: SPPLocale -> Text

toEncodedQueryParam :: SPPLocale -> Builder

FromJSON SPPLocale

Defined in Data.EBird.API.Taxonomy

Methods

parseJSON :: Value -> Parser SPPLocale

parseJSONList :: Value -> Parser [SPPLocale]

ToJSON SPPLocale

Defined in Data.EBird.API.Taxonomy

Methods

toJSON :: SPPLocale -> Value

toEncoding :: SPPLocale -> Encoding

toJSONList :: [SPPLocale] -> Value

toEncodingList :: [SPPLocale] -> Encoding

data SPPLocaleListEntry

Values returned from the TaxaLocaleCodesAPI.

Constructors

SPPLocaleListEntry

Fields

• _sppLocaleListEntryCode :: SPPLocale

  The code of the locale, e.g. En_US

• _sppLocaleListEntryName :: Text

  The name, e.g. "English (United States)"

• _sppLocaleListEntryLastUpdate :: Text

  The date and time of the last update for this locale

Instances

Read SPPLocaleListEntry

Defined in Data.EBird.API.Taxonomy

Methods

readsPrec :: Int -> ReadS SPPLocaleListEntry

readList :: ReadS [SPPLocaleListEntry]

readPrec :: ReadPrec SPPLocaleListEntry

readListPrec :: ReadPrec [SPPLocaleListEntry]

Show SPPLocaleListEntry

Defined in Data.EBird.API.Taxonomy

Methods

showsPrec :: Int -> SPPLocaleListEntry -> ShowS

show :: SPPLocaleListEntry -> String

showList :: [SPPLocaleListEntry] -> ShowS

Eq SPPLocaleListEntry

Defined in Data.EBird.API.Taxonomy

Methods

(==) :: SPPLocaleListEntry -> SPPLocaleListEntry -> Bool

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

FromJSON SPPLocaleListEntry

Explicit instance for compatibility with their field names

Defined in Data.EBird.API.Taxonomy

Methods

parseJSON :: Value -> Parser SPPLocaleListEntry

parseJSONList :: Value -> Parser [SPPLocaleListEntry]

ToJSON SPPLocaleListEntry

Explicit instance for compatibility with their field names

Defined in Data.EBird.API.Taxonomy

Methods

toJSON :: SPPLocaleListEntry -> Value

toEncoding :: SPPLocaleListEntry -> Encoding

toJSONList :: [SPPLocaleListEntry] -> Value

toEncodingList :: [SPPLocaleListEntry] -> Encoding

data SPPGrouping

Values represent the different ways that taxonomic groups may be grouped. MerlinGrouping puts like birds together, with falcons next to hawks. EBirdGrouping follows taxonomic order.

Constructors

MerlinGrouping

EBirdGrouping

Instances

IsString SPPGrouping

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

Defined in Data.EBird.API.Taxonomy

Methods

fromString :: String -> SPPGrouping

Read SPPGrouping

Defined in Data.EBird.API.Taxonomy

Methods

readsPrec :: Int -> ReadS SPPGrouping

readList :: ReadS [SPPGrouping]

readPrec :: ReadPrec SPPGrouping

readListPrec :: ReadPrec [SPPGrouping]

Show SPPGrouping

Defined in Data.EBird.API.Taxonomy

Methods

showsPrec :: Int -> SPPGrouping -> ShowS

show :: SPPGrouping -> String

showList :: [SPPGrouping] -> ShowS

EBirdString SPPGrouping

The eBird string of an SPPGrouping is either "merlin" or "ebird"

Defined in Data.EBird.API.Taxonomy

Methods

toEBirdString :: SPPGrouping -> Text

fromEBirdString :: Text -> Either Text SPPGrouping

Eq SPPGrouping

Defined in Data.EBird.API.Taxonomy

Methods

(==) :: SPPGrouping -> SPPGrouping -> Bool

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

ToHttpApiData SPPGrouping

Defined in Data.EBird.API.Taxonomy

Methods

toUrlPiece :: SPPGrouping -> Text

toEncodedUrlPiece :: SPPGrouping -> Builder

toHeader :: SPPGrouping -> ByteString

toQueryParam :: SPPGrouping -> Text

toEncodedQueryParam :: SPPGrouping -> Builder

data TaxonomicGroupListEntry

Values returned by the TaxonomicGroupsAPI.

Constructors

TaxonomicGroupListEntry

Fields

• _taxonomicGroupListEntryName :: Text

  Name of the group, e.g. "Waterfowl"

• _taxonomicGroupListEntryOrder :: Integer

  Numeric value determining the location of this group in the list

• _taxonomicGroupListEntryOrderBounds :: [(Integer, Integer)]

  The bounds of the ordering, depending on the grouping

Instances

Read TaxonomicGroupListEntry

Defined in Data.EBird.API.Taxonomy

Methods

readsPrec :: Int -> ReadS TaxonomicGroupListEntry

readList :: ReadS [TaxonomicGroupListEntry]

readPrec :: ReadPrec TaxonomicGroupListEntry

readListPrec :: ReadPrec [TaxonomicGroupListEntry]

Show TaxonomicGroupListEntry

Defined in Data.EBird.API.Taxonomy

Methods

showsPrec :: Int -> TaxonomicGroupListEntry -> ShowS

show :: TaxonomicGroupListEntry -> String

showList :: [TaxonomicGroupListEntry] -> ShowS

Eq TaxonomicGroupListEntry

Defined in Data.EBird.API.Taxonomy

Methods

(==) :: TaxonomicGroupListEntry -> TaxonomicGroupListEntry -> Bool

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

FromJSON TaxonomicGroupListEntry

Explicit instance for compatibility with their field names

Defined in Data.EBird.API.Taxonomy

Methods

parseJSON :: Value -> Parser TaxonomicGroupListEntry

parseJSONList :: Value -> Parser [TaxonomicGroupListEntry]

ToJSON TaxonomicGroupListEntry

Explicit instance for compatibility with their field names

Defined in Data.EBird.API.Taxonomy

Methods

toJSON :: TaxonomicGroupListEntry -> Value

toEncoding :: TaxonomicGroupListEntry -> Encoding

toJSONList :: [TaxonomicGroupListEntry] -> Value

toEncodingList :: [TaxonomicGroupListEntry] -> Encoding

(k ~ A_Lens, a ~ Text, b ~ Text) => LabelOptic "name" k TaxonomicGroupListEntry TaxonomicGroupListEntry a b

Defined in Data.EBird.API.Taxonomy

Methods

labelOptic :: Optic k NoIx TaxonomicGroupListEntry TaxonomicGroupListEntry a b

(k ~ A_Lens, a ~ Integer, b ~ Integer) => LabelOptic "order" k TaxonomicGroupListEntry TaxonomicGroupListEntry a b

Defined in Data.EBird.API.Taxonomy

Methods

labelOptic :: Optic k NoIx TaxonomicGroupListEntry TaxonomicGroupListEntry a b

(k ~ A_Lens, a ~ [(Integer, Integer)], b ~ [(Integer, Integer)]) => LabelOptic "orderBounds" k TaxonomicGroupListEntry TaxonomicGroupListEntry a b

Defined in Data.EBird.API.Taxonomy

Methods

labelOptic :: Optic k NoIx TaxonomicGroupListEntry TaxonomicGroupListEntry a b

data TaxonomyVersionListEntry

Values returned by the TaxonomyVersionsAPI.

Constructors

TaxonomyVersionListEntry

Fields

• _taxonomyVersionAuthorityVersion :: Double
• _taxonomyVersionLatest :: Bool

Instances

Read TaxonomyVersionListEntry

Defined in Data.EBird.API.Taxonomy

Methods

readsPrec :: Int -> ReadS TaxonomyVersionListEntry

readList :: ReadS [TaxonomyVersionListEntry]

readPrec :: ReadPrec TaxonomyVersionListEntry

readListPrec :: ReadPrec [TaxonomyVersionListEntry]

Show TaxonomyVersionListEntry

Defined in Data.EBird.API.Taxonomy

Methods

showsPrec :: Int -> TaxonomyVersionListEntry -> ShowS

show :: TaxonomyVersionListEntry -> String

showList :: [TaxonomyVersionListEntry] -> ShowS

Eq TaxonomyVersionListEntry

Defined in Data.EBird.API.Taxonomy

Methods

(==) :: TaxonomyVersionListEntry -> TaxonomyVersionListEntry -> Bool

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

FromJSON TaxonomyVersionListEntry

Explicit instance for compatibility with their field names

Defined in Data.EBird.API.Taxonomy

Methods

parseJSON :: Value -> Parser TaxonomyVersionListEntry

parseJSONList :: Value -> Parser [TaxonomyVersionListEntry]

ToJSON TaxonomyVersionListEntry

Explicit instance for compatibility with their field names

Defined in Data.EBird.API.Taxonomy

Methods

toJSON :: TaxonomyVersionListEntry -> Value

toEncoding :: TaxonomyVersionListEntry -> Encoding

toJSONList :: [TaxonomyVersionListEntry] -> Value

toEncodingList :: [TaxonomyVersionListEntry] -> Encoding

Optics for taxonomy-related types

sppLocaleListEntryName :: Lens' SPPLocaleListEntry Text

sppLocaleListEntryLastUpdate :: Lens' SPPLocaleListEntry Text

sppLocaleListEntryCode :: Lens' SPPLocaleListEntry SPPLocale

taxonomicGroupListEntryOrderBounds :: Lens' TaxonomicGroupListEntry [(Integer, Integer)]

taxonomicGroupListEntryOrder :: Lens' TaxonomicGroupListEntry Integer

taxonomicGroupListEntryName :: Lens' TaxonomicGroupListEntry Text

taxonomyVersionLatest :: Lens' TaxonomyVersionListEntry Bool

taxonomyVersionAuthorityVersion :: Lens' TaxonomyVersionListEntry Double

attoparsec parsers

parseSpeciesCode :: Parser SpeciesCode

Parse an eBird species code, which we loosely assume is a string of one or more alphanumeric characters.

parseSpeciesCodes :: Parser SpeciesCodes

Parse a comma separated list of zero or more SpeciesCodes

parseTaxonomyCategory :: Parser TaxonomyCategory

Parse an eBird TaxonomyCategory.

parseTaxonomyCategories :: Parser TaxonomyCategories

Parse a list of eBird API taxononomy categories. To avoid the partial behavior of converting a sepBy1 result into a NonEmpty, we manually parse the first category followed by an optional tail.

parseSPPLocale :: Parser SPPLocale

Parse an eBird SPPLocale.

parseSPPGrouping :: Parser SPPGrouping

Parse an eBird SPPGrouping.