Data.EBird.API.Checklists

Types related to eBird checklist API values.

Checklist types

data Checklist

Values returned by the ViewChecklistAPI

Constructors

Checklist

Fields

• _checklistProjectId :: Text

  Project ID, e.g. "EBIRD"

• _checklistSubId :: Text

  Checklist submission ID, e.g. "S144646447"

• _checklistProtocolId :: Text

  Checklist protocol ID, e.g. "P21"

• _checklistLocationId :: Text

  Checklist location ID

• _checklistGroupId :: Text

  Checklist group ID

• _checklistDurationHours :: Maybe Double

  Checklist duration, only Just for checklists of appropriate protocols (e.g. not incidentals)

• _checklistAllObsReported :: Bool

  Was every bird observed reported?

• _checklistCreationDateTime :: EBirdDateTime

  What date and time was the checklist created (i.e. submitted)?

• _checklistLastEditedDateTime :: EBirdDateTime

  What date and time what the checklist last edited?

• _checklistObsDateTime :: EBirdDateTime

  What date and time what the checklist started?

• _checklistObsTimeValid :: Bool

  TODO: Not sure what this is for

• _checklistChecklistId :: Text

  The ID of the checklist, e.g. "CL24936"

• _checklistNumObservers :: Integer

  The number of observers on this checklist

• _checklistEffortDistanceKm :: Maybe Double

  Distance travelled during this checklist in kilometers, only Just for checklists of appropriate protocols (e.g. not incidentals)

• _checklistEffortDistanceEnteredUnit :: Maybe Text

  The unit of distance used for the checklist submission (e.g. "mi"), only Just for checklists of appropriate protocols (e.g. not incidentals)

• _checklistSubnational1Code :: Region

  The subnational1 region (state) that the checklist was submitted in

• _checklistSubmissionMethodCode :: Text

  Method of checklist submission

• _checklistSubmissionMethodVersion :: Text

  Version of the method of checklist submission, e.g. "2.13.2_SDK33"

• _checklistSubmissionMethodVersionDisp :: Text

  Display-ready version of the method of checklist submission, e.g. "2.13.2"

• _checklistUserDisplayName :: Text

  Display name of the user that submitted the checklist

• _checklistNumSpecies :: Integer

  Number of species included in observations on this checklist

• _checklistSubAux :: [SubAux]

  Submission auxiliary entry methods

  TODO: Not sure what these are about

• _checklistSubAuxAI :: [SubAuxAI]

  Submission auxiliary entry methods that use aritificial intelligence

  TODO: Not sure what these are about

• _checklistObs :: [ChecklistObservation]

  Observations included in the checklist

Instances

Read Checklist

Defined in Data.EBird.API.Checklists

Methods

readsPrec :: Int -> ReadS Checklist

readList :: ReadS [Checklist]

readPrec :: ReadPrec Checklist

readListPrec :: ReadPrec [Checklist]

Show Checklist

Defined in Data.EBird.API.Checklists

Methods

showsPrec :: Int -> Checklist -> ShowS

show :: Checklist -> String

showList :: [Checklist] -> ShowS

Eq Checklist

Defined in Data.EBird.API.Checklists

Methods

(==) :: Checklist -> Checklist -> Bool

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

FromJSON Checklist

Explicit instance for compatibility with their field names

Defined in Data.EBird.API.Checklists

Methods

parseJSON :: Value -> Parser Checklist

parseJSONList :: Value -> Parser [Checklist]

ToJSON Checklist

Explicit instance for compatibility with their field names

Defined in Data.EBird.API.Checklists

Methods

toJSON :: Checklist -> Value

toEncoding :: Checklist -> Encoding

toJSONList :: [Checklist] -> Value

toEncodingList :: [Checklist] -> Encoding

(k ~ A_Lens, a ~ Bool, b ~ Bool) => LabelOptic "allObsReported" k Checklist Checklist a b

Defined in Data.EBird.API.Checklists

Methods

labelOptic :: Optic k NoIx Checklist Checklist a b

(k ~ A_Lens, a ~ Text, b ~ Text) => LabelOptic "checklistId" k Checklist Checklist a b

Defined in Data.EBird.API.Checklists

Methods

labelOptic :: Optic k NoIx Checklist Checklist a b

(k ~ A_Lens, a ~ EBirdDateTime, b ~ EBirdDateTime) => LabelOptic "creationDateTime" k Checklist Checklist a b

Defined in Data.EBird.API.Checklists

Methods

labelOptic :: Optic k NoIx Checklist Checklist a b

(k ~ A_Lens, a ~ Maybe Double, b ~ Maybe Double) => LabelOptic "durationHours" k Checklist Checklist a b

Defined in Data.EBird.API.Checklists

Methods

labelOptic :: Optic k NoIx Checklist Checklist a b

(k ~ A_Lens, a ~ Maybe Text, b ~ Maybe Text) => LabelOptic "effortDistanceEnteredUnit" k Checklist Checklist a b

Defined in Data.EBird.API.Checklists

Methods

labelOptic :: Optic k NoIx Checklist Checklist a b

(k ~ A_Lens, a ~ Maybe Double, b ~ Maybe Double) => LabelOptic "effortDistanceKm" k Checklist Checklist a b

Defined in Data.EBird.API.Checklists

Methods

labelOptic :: Optic k NoIx Checklist Checklist a b

(k ~ A_Lens, a ~ Text, b ~ Text) => LabelOptic "groupId" k Checklist Checklist a b

Defined in Data.EBird.API.Checklists

Methods

labelOptic :: Optic k NoIx Checklist Checklist a b

(k ~ A_Lens, a ~ EBirdDateTime, b ~ EBirdDateTime) => LabelOptic "lastEditedDateTime" k Checklist Checklist a b

Defined in Data.EBird.API.Checklists

Methods

labelOptic :: Optic k NoIx Checklist Checklist a b

(k ~ A_Lens, a ~ Text, b ~ Text) => LabelOptic "locationId" k Checklist Checklist a b

Defined in Data.EBird.API.Checklists

Methods

labelOptic :: Optic k NoIx Checklist Checklist a b

(k ~ A_Lens, a ~ Integer, b ~ Integer) => LabelOptic "numObservers" k Checklist Checklist a b

Defined in Data.EBird.API.Checklists

Methods

labelOptic :: Optic k NoIx Checklist Checklist a b

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

Defined in Data.EBird.API.Checklists

Methods

labelOptic :: Optic k NoIx Checklist Checklist a b

(k ~ A_Lens, a ~ [ChecklistObservation], b ~ [ChecklistObservation]) => LabelOptic "obs" k Checklist Checklist a b

Defined in Data.EBird.API.Checklists

Methods

labelOptic :: Optic k NoIx Checklist Checklist a b

(k ~ A_Lens, a ~ EBirdDateTime, b ~ EBirdDateTime) => LabelOptic "obsDateTime" k Checklist Checklist a b

Defined in Data.EBird.API.Checklists

Methods

labelOptic :: Optic k NoIx Checklist Checklist a b

(k ~ A_Lens, a ~ Bool, b ~ Bool) => LabelOptic "obsTimeValid" k Checklist Checklist a b

Defined in Data.EBird.API.Checklists

Methods

labelOptic :: Optic k NoIx Checklist Checklist a b

(k ~ A_Lens, a ~ Text, b ~ Text) => LabelOptic "projectId" k Checklist Checklist a b

Defined in Data.EBird.API.Checklists

Methods

labelOptic :: Optic k NoIx Checklist Checklist a b

(k ~ A_Lens, a ~ Text, b ~ Text) => LabelOptic "protocolId" k Checklist Checklist a b

Defined in Data.EBird.API.Checklists

Methods

labelOptic :: Optic k NoIx Checklist Checklist a b

(k ~ A_Lens, a ~ [SubAux], b ~ [SubAux]) => LabelOptic "subAux" k Checklist Checklist a b

Defined in Data.EBird.API.Checklists

Methods

labelOptic :: Optic k NoIx Checklist Checklist a b

(k ~ A_Lens, a ~ [SubAuxAI], b ~ [SubAuxAI]) => LabelOptic "subAuxAI" k Checklist Checklist a b

Defined in Data.EBird.API.Checklists

Methods

labelOptic :: Optic k NoIx Checklist Checklist a b

(k ~ A_Lens, a ~ Text, b ~ Text) => LabelOptic "subId" k Checklist Checklist a b

Defined in Data.EBird.API.Checklists

Methods

labelOptic :: Optic k NoIx Checklist Checklist a b

(k ~ A_Lens, a ~ Text, b ~ Text) => LabelOptic "submissionMethodCode" k Checklist Checklist a b

Defined in Data.EBird.API.Checklists

Methods

labelOptic :: Optic k NoIx Checklist Checklist a b

(k ~ A_Lens, a ~ Text, b ~ Text) => LabelOptic "submissionMethodVersion" k Checklist Checklist a b

Defined in Data.EBird.API.Checklists

Methods

labelOptic :: Optic k NoIx Checklist Checklist a b

(k ~ A_Lens, a ~ Text, b ~ Text) => LabelOptic "submissionMethodVersionDisp" k Checklist Checklist a b

Defined in Data.EBird.API.Checklists

Methods

labelOptic :: Optic k NoIx Checklist Checklist a b

(k ~ A_Lens, a ~ Region, b ~ Region) => LabelOptic "subnational1Code" k Checklist Checklist a b

Defined in Data.EBird.API.Checklists

Methods

labelOptic :: Optic k NoIx Checklist Checklist a b

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

Defined in Data.EBird.API.Checklists

Methods

labelOptic :: Optic k NoIx Checklist Checklist a b

data ChecklistObservation

Observation values included in checklists.

Constructors

ChecklistObservation

Fields

• _checklistObservationSpeciesCode :: SpeciesCode

  Species code of the species, e.g. "norfli"

• _checklistObservationObsDateTime :: EBirdDateTime

  The date and time of the observation. It is not clear when this would not be equal to the checklistObsDateTime field of the enclosing checklist.

• _checklistObservationObsId :: Text

  ID of the observation

• _checklistObservationHowManyStr :: Text

  A string representation of the quantity of the observation. If just the presence is noted, the string will be "X"

Instances

Read ChecklistObservation

Defined in Data.EBird.API.Checklists

Methods

readsPrec :: Int -> ReadS ChecklistObservation

readList :: ReadS [ChecklistObservation]

readPrec :: ReadPrec ChecklistObservation

readListPrec :: ReadPrec [ChecklistObservation]

Show ChecklistObservation

Defined in Data.EBird.API.Checklists

Methods

showsPrec :: Int -> ChecklistObservation -> ShowS

show :: ChecklistObservation -> String

showList :: [ChecklistObservation] -> ShowS

Eq ChecklistObservation

Defined in Data.EBird.API.Checklists

Methods

(==) :: ChecklistObservation -> ChecklistObservation -> Bool

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

FromJSON ChecklistObservation

Explicit instance for compatibility with their field names

Defined in Data.EBird.API.Checklists

Methods

parseJSON :: Value -> Parser ChecklistObservation

parseJSONList :: Value -> Parser [ChecklistObservation]

ToJSON ChecklistObservation

Explicit instance for compatibility with their field names

Defined in Data.EBird.API.Checklists

Methods

toJSON :: ChecklistObservation -> Value

toEncoding :: ChecklistObservation -> Encoding

toJSONList :: [ChecklistObservation] -> Value

toEncodingList :: [ChecklistObservation] -> Encoding

(k ~ A_Lens, a ~ Text, b ~ Text) => LabelOptic "howManyStr" k ChecklistObservation ChecklistObservation a b

Defined in Data.EBird.API.Checklists

Methods

labelOptic :: Optic k NoIx ChecklistObservation ChecklistObservation a b

(k ~ A_Lens, a ~ EBirdDateTime, b ~ EBirdDateTime) => LabelOptic "obsDateTime" k ChecklistObservation ChecklistObservation a b

Defined in Data.EBird.API.Checklists

Methods

labelOptic :: Optic k NoIx ChecklistObservation ChecklistObservation a b

(k ~ A_Lens, a ~ Text, b ~ Text) => LabelOptic "obsId" k ChecklistObservation ChecklistObservation a b

Defined in Data.EBird.API.Checklists

Methods

labelOptic :: Optic k NoIx ChecklistObservation ChecklistObservation a b

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

Defined in Data.EBird.API.Checklists

Methods

labelOptic :: Optic k NoIx ChecklistObservation ChecklistObservation a b

data SubAux

Values included in the checklistSubAux field of Checklists.

Constructors

SubAux

Fields

• _subAuxSubId :: Text

  Submission ID

• _subAuxFieldName :: Text

  E.g. "nocturnal"

• _subAuxEntryMethodCode :: Text

  E.g. "ebird_nocturnal"

• _subAuxAuxCode :: Text

  E.g. "0"

Instances

Read SubAux

Defined in Data.EBird.API.Checklists

Methods

readsPrec :: Int -> ReadS SubAux

readList :: ReadS [SubAux]

readPrec :: ReadPrec SubAux

readListPrec :: ReadPrec [SubAux]

Show SubAux

Defined in Data.EBird.API.Checklists

Methods

showsPrec :: Int -> SubAux -> ShowS

show :: SubAux -> String

showList :: [SubAux] -> ShowS

Eq SubAux

Defined in Data.EBird.API.Checklists

Methods

(==) :: SubAux -> SubAux -> Bool

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

FromJSON SubAux

Explicit instance for compatibility with their field names

Defined in Data.EBird.API.Checklists

Methods

parseJSON :: Value -> Parser SubAux

parseJSONList :: Value -> Parser [SubAux]

ToJSON SubAux

Explicit instance for compatibility with their field names

Defined in Data.EBird.API.Checklists

Methods

toJSON :: SubAux -> Value

toEncoding :: SubAux -> Encoding

toJSONList :: [SubAux] -> Value

toEncodingList :: [SubAux] -> Encoding

(k ~ A_Lens, a ~ Text, b ~ Text) => LabelOptic "auxCode" k SubAux SubAux a b

Defined in Data.EBird.API.Checklists

Methods

labelOptic :: Optic k NoIx SubAux SubAux a b

(k ~ A_Lens, a ~ Text, b ~ Text) => LabelOptic "entryMethodCode" k SubAux SubAux a b

Defined in Data.EBird.API.Checklists

Methods

labelOptic :: Optic k NoIx SubAux SubAux a b

(k ~ A_Lens, a ~ Text, b ~ Text) => LabelOptic "fieldName" k SubAux SubAux a b

Defined in Data.EBird.API.Checklists

Methods

labelOptic :: Optic k NoIx SubAux SubAux a b

(k ~ A_Lens, a ~ Text, b ~ Text) => LabelOptic "subId" k SubAux SubAux a b

Defined in Data.EBird.API.Checklists

Methods

labelOptic :: Optic k NoIx SubAux SubAux a b

data SubAuxAI

Values included in the checklistSubAuxAI field of Checklists.

Constructors

SubAuxAI

Fields

• _subAuxAISubId :: Text

  Submission ID

• _subAuxAIMethod :: Text

  E.g. "concurrent"

• _subAuxAIType :: Text

  E.g. "sound"

• _subAuxAISource :: Text

  E.g. "merlin"

• _subAuxEventId :: Integer

  E.g. 0

Instances

Read SubAuxAI

Defined in Data.EBird.API.Checklists

Methods

readsPrec :: Int -> ReadS SubAuxAI

readList :: ReadS [SubAuxAI]

readPrec :: ReadPrec SubAuxAI

readListPrec :: ReadPrec [SubAuxAI]

Show SubAuxAI

Defined in Data.EBird.API.Checklists

Methods

showsPrec :: Int -> SubAuxAI -> ShowS

show :: SubAuxAI -> String

showList :: [SubAuxAI] -> ShowS

Eq SubAuxAI

Defined in Data.EBird.API.Checklists

Methods

(==) :: SubAuxAI -> SubAuxAI -> Bool

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

FromJSON SubAuxAI

Explicit instance for compatibility with their field names

Defined in Data.EBird.API.Checklists

Methods

parseJSON :: Value -> Parser SubAuxAI

parseJSONList :: Value -> Parser [SubAuxAI]

ToJSON SubAuxAI

Explicit instance for compatibility with their field names

Defined in Data.EBird.API.Checklists

Methods

toJSON :: SubAuxAI -> Value

toEncoding :: SubAuxAI -> Encoding

toJSONList :: [SubAuxAI] -> Value

toEncodingList :: [SubAuxAI] -> Encoding

(k ~ A_Lens, a ~ Text, b ~ Text) => LabelOptic "method" k SubAuxAI SubAuxAI a b

Defined in Data.EBird.API.Checklists

Methods

labelOptic :: Optic k NoIx SubAuxAI SubAuxAI a b

(k ~ A_Lens, a ~ Text, b ~ Text) => LabelOptic "source" k SubAuxAI SubAuxAI a b

Defined in Data.EBird.API.Checklists

Methods

labelOptic :: Optic k NoIx SubAuxAI SubAuxAI a b

(k ~ A_Lens, a ~ Text, b ~ Text) => LabelOptic "subId" k SubAuxAI SubAuxAI a b

Defined in Data.EBird.API.Checklists

Methods

labelOptic :: Optic k NoIx SubAuxAI SubAuxAI a b

(k ~ A_Lens, a ~ Text, b ~ Text) => LabelOptic "type" k SubAuxAI SubAuxAI a b

Defined in Data.EBird.API.Checklists

Methods

labelOptic :: Optic k NoIx SubAuxAI SubAuxAI a b

data ChecklistFeedEntry

eBird checklists. Note that we do not include some redundant fields of checklist values returned by the API (e.g. subID, which is always the same value as subId).

Constructors

ChecklistFeedEntry

Fields

• _checklistFeedEntryLocationId :: Text

  The location ID of the checklist

• _checklistFeedEntrySubId :: Text

  Checklist submission ID

• _checklistFeedEntryUserDisplayName :: Text

  The display name of the user that submitted this checklist

• _checklistFeedEntryNumSpecies :: Integer

  Number of species included on this checklist

• _checklistFeedEntryDate :: EBirdDate

  Date that this checklist was started

• _checklistFeedEntryTime :: EBirdTime

  Time that this checklist was started

• _checklistFeedEntryLocationData :: LocationData

  Location data for the checklist

Instances

Read ChecklistFeedEntry

Defined in Data.EBird.API.Checklists

Methods

readsPrec :: Int -> ReadS ChecklistFeedEntry

readList :: ReadS [ChecklistFeedEntry]

readPrec :: ReadPrec ChecklistFeedEntry

readListPrec :: ReadPrec [ChecklistFeedEntry]

Show ChecklistFeedEntry

Defined in Data.EBird.API.Checklists

Methods

showsPrec :: Int -> ChecklistFeedEntry -> ShowS

show :: ChecklistFeedEntry -> String

showList :: [ChecklistFeedEntry] -> ShowS

Eq ChecklistFeedEntry

Defined in Data.EBird.API.Checklists

Methods

(==) :: ChecklistFeedEntry -> ChecklistFeedEntry -> Bool

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

FromJSON ChecklistFeedEntry

Explicit instance for compatibility with their field names

Defined in Data.EBird.API.Checklists

Methods

parseJSON :: Value -> Parser ChecklistFeedEntry

parseJSONList :: Value -> Parser [ChecklistFeedEntry]

ToJSON ChecklistFeedEntry

Explicit instance for compatibility with their field names

Defined in Data.EBird.API.Checklists

Methods

toJSON :: ChecklistFeedEntry -> Value

toEncoding :: ChecklistFeedEntry -> Encoding

toJSONList :: [ChecklistFeedEntry] -> Value

toEncodingList :: [ChecklistFeedEntry] -> Encoding

(k ~ A_Lens, a ~ EBirdDate, b ~ EBirdDate) => LabelOptic "date" k ChecklistFeedEntry ChecklistFeedEntry a b

Defined in Data.EBird.API.Checklists

Methods

labelOptic :: Optic k NoIx ChecklistFeedEntry ChecklistFeedEntry a b

(k ~ A_Lens, a ~ LocationData, b ~ LocationData) => LabelOptic "locationData" k ChecklistFeedEntry ChecklistFeedEntry a b

Defined in Data.EBird.API.Checklists

Methods

labelOptic :: Optic k NoIx ChecklistFeedEntry ChecklistFeedEntry a b

(k ~ A_Lens, a ~ Text, b ~ Text) => LabelOptic "locationId" k ChecklistFeedEntry ChecklistFeedEntry a b

Defined in Data.EBird.API.Checklists

Methods

labelOptic :: Optic k NoIx ChecklistFeedEntry ChecklistFeedEntry a b

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

Defined in Data.EBird.API.Checklists

Methods

labelOptic :: Optic k NoIx ChecklistFeedEntry ChecklistFeedEntry a b

(k ~ A_Lens, a ~ Text, b ~ Text) => LabelOptic "subId" k ChecklistFeedEntry ChecklistFeedEntry a b

Defined in Data.EBird.API.Checklists

Methods

labelOptic :: Optic k NoIx ChecklistFeedEntry ChecklistFeedEntry a b

(k ~ A_Lens, a ~ EBirdTime, b ~ EBirdTime) => LabelOptic "time" k ChecklistFeedEntry ChecklistFeedEntry a b

Defined in Data.EBird.API.Checklists

Methods

labelOptic :: Optic k NoIx ChecklistFeedEntry ChecklistFeedEntry a b

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

Defined in Data.EBird.API.Checklists

Methods

labelOptic :: Optic k NoIx ChecklistFeedEntry ChecklistFeedEntry a b

data LocationData

eBird checklist or hotspot location data. Note that we do not include some redundant fields of location data values returned by the API (e.g. locName, which is always the same value as name).

Constructors

LocationData

Fields

• _locationDataName :: Text

  Name of the location

• _locationDataLatitude :: Double

  Latitude of the location

• _locationDataLongitude :: Double

  Longitude of the location

• _locationDataCountryCode :: Region

  Country code of the location

• _locationDataCountryName :: Text

  Country name of the location

• _locationDataSubnational1Code :: Region

  Subnational1 region that this location is in

• _locationDataSubnational1Name :: Text

  Name of the subnational1 region that this location is in

• _locationDataSubnational2Code :: Region

  Subnational2 region that this location is in

• _locationDataSubnational2Name :: Text

  Name of the subnational2 region that this location is in

• _locationDataIsHotspot :: Bool

  Is this location an eBird hotspot?

• _locationDataHeirarchicalName :: Text

  A compound name for the location consisting of the location name, county name, state name, and country name.

Instances

Read LocationData

Defined in Data.EBird.API.Checklists

Methods

readsPrec :: Int -> ReadS LocationData

readList :: ReadS [LocationData]

readPrec :: ReadPrec LocationData

readListPrec :: ReadPrec [LocationData]

Show LocationData

Defined in Data.EBird.API.Checklists

Methods

showsPrec :: Int -> LocationData -> ShowS

show :: LocationData -> String

showList :: [LocationData] -> ShowS

Eq LocationData

Defined in Data.EBird.API.Checklists

Methods

(==) :: LocationData -> LocationData -> Bool

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

FromJSON LocationData

Explicit instance for compatibility with their field names

Defined in Data.EBird.API.Checklists

Methods

parseJSON :: Value -> Parser LocationData

parseJSONList :: Value -> Parser [LocationData]

ToJSON LocationData

Explicit instance for compatibility with their field names

Defined in Data.EBird.API.Checklists

Methods

toJSON :: LocationData -> Value

toEncoding :: LocationData -> Encoding

toJSONList :: [LocationData] -> Value

toEncodingList :: [LocationData] -> Encoding

(k ~ A_Lens, a ~ Region, b ~ Region) => LabelOptic "countryCode" k LocationData LocationData a b

Defined in Data.EBird.API.Checklists

Methods

labelOptic :: Optic k NoIx LocationData LocationData a b

(k ~ A_Lens, a ~ Text, b ~ Text) => LabelOptic "countryName" k LocationData LocationData a b

Defined in Data.EBird.API.Checklists

Methods

labelOptic :: Optic k NoIx LocationData LocationData a b

(k ~ A_Lens, a ~ Text, b ~ Text) => LabelOptic "heirarchicalName" k LocationData LocationData a b

Defined in Data.EBird.API.Checklists

Methods

labelOptic :: Optic k NoIx LocationData LocationData a b

(k ~ A_Lens, a ~ Bool, b ~ Bool) => LabelOptic "isHotspot" k LocationData LocationData a b

Defined in Data.EBird.API.Checklists

Methods

labelOptic :: Optic k NoIx LocationData LocationData a b

(k ~ A_Lens, a ~ Double, b ~ Double) => LabelOptic "latitude" k LocationData LocationData a b

Defined in Data.EBird.API.Checklists

Methods

labelOptic :: Optic k NoIx LocationData LocationData a b

(k ~ A_Lens, a ~ Double, b ~ Double) => LabelOptic "longitude" k LocationData LocationData a b

Defined in Data.EBird.API.Checklists

Methods

labelOptic :: Optic k NoIx LocationData LocationData a b

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

Defined in Data.EBird.API.Checklists

Methods

labelOptic :: Optic k NoIx LocationData LocationData a b

(k ~ A_Lens, a ~ Region, b ~ Region) => LabelOptic "subnational1Code" k LocationData LocationData a b

Defined in Data.EBird.API.Checklists

Methods

labelOptic :: Optic k NoIx LocationData LocationData a b

(k ~ A_Lens, a ~ Text, b ~ Text) => LabelOptic "subnational1Name" k LocationData LocationData a b

Defined in Data.EBird.API.Checklists

Methods

labelOptic :: Optic k NoIx LocationData LocationData a b

(k ~ A_Lens, a ~ Region, b ~ Region) => LabelOptic "subnational2Code" k LocationData LocationData a b

Defined in Data.EBird.API.Checklists

Methods

labelOptic :: Optic k NoIx LocationData LocationData a b

(k ~ A_Lens, a ~ Text, b ~ Text) => LabelOptic "subnational2Name" k LocationData LocationData a b

Defined in Data.EBird.API.Checklists

Methods

labelOptic :: Optic k NoIx LocationData LocationData a b

Auxiliary eBird checklist-related API types

data SortChecklistsBy

How to rank the list returned by the Top100API.

Constructors

SortChecklistsByDateCreated

Sort checklists by the date of the observations they contain

SortChecklistsByDateSubmitted

Sort checklists by the date they were submitted

Instances

IsString SortChecklistsBy

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

Defined in Data.EBird.API.Checklists

Methods

fromString :: String -> SortChecklistsBy

Read SortChecklistsBy

Defined in Data.EBird.API.Checklists

Methods

readsPrec :: Int -> ReadS SortChecklistsBy

readList :: ReadS [SortChecklistsBy]

readPrec :: ReadPrec SortChecklistsBy

readListPrec :: ReadPrec [SortChecklistsBy]

Show SortChecklistsBy

Defined in Data.EBird.API.Checklists

Methods

showsPrec :: Int -> SortChecklistsBy -> ShowS

show :: SortChecklistsBy -> String

showList :: [SortChecklistsBy] -> ShowS

EBirdString SortChecklistsBy

The eBird string for a SortChecklistsBy value is either "obs_dt" or "creation_dt".

Defined in Data.EBird.API.Checklists

Methods

toEBirdString :: SortChecklistsBy -> Text

fromEBirdString :: Text -> Either Text SortChecklistsBy

Eq SortChecklistsBy

Defined in Data.EBird.API.Checklists

Methods

(==) :: SortChecklistsBy -> SortChecklistsBy -> Bool

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

ToHttpApiData SortChecklistsBy

Defined in Data.EBird.API.Checklists

Methods

toUrlPiece :: SortChecklistsBy -> Text

toEncodedUrlPiece :: SortChecklistsBy -> Builder

toHeader :: SortChecklistsBy -> ByteString

toQueryParam :: SortChecklistsBy -> Text

toEncodedQueryParam :: SortChecklistsBy -> Builder

Optics for checklist types

checklistUserDisplayName :: Lens' Checklist Text

checklistSubnational1Code :: Lens' Checklist Region

checklistSubmissionMethodVersionDisp :: Lens' Checklist Text

checklistSubmissionMethodVersion :: Lens' Checklist Text

checklistSubmissionMethodCode :: Lens' Checklist Text

checklistSubId :: Lens' Checklist Text

checklistSubAuxAI :: Lens' Checklist [SubAuxAI]

checklistSubAux :: Lens' Checklist [SubAux]

checklistProtocolId :: Lens' Checklist Text

checklistProjectId :: Lens' Checklist Text

checklistObsTimeValid :: Lens' Checklist Bool

checklistObsDateTime :: Lens' Checklist EBirdDateTime

checklistObs :: Lens' Checklist [ChecklistObservation]

checklistNumSpecies :: Lens' Checklist Integer

checklistNumObservers :: Lens' Checklist Integer

checklistLocationId :: Lens' Checklist Text

checklistLastEditedDateTime :: Lens' Checklist EBirdDateTime

checklistGroupId :: Lens' Checklist Text

checklistEffortDistanceKm :: Lens' Checklist (Maybe Double)

checklistEffortDistanceEnteredUnit :: Lens' Checklist (Maybe Text)

checklistDurationHours :: Lens' Checklist (Maybe Double)

checklistCreationDateTime :: Lens' Checklist EBirdDateTime

checklistChecklistId :: Lens' Checklist Text

checklistAllObsReported :: Lens' Checklist Bool

checklistObservationSpeciesCode :: Lens' ChecklistObservation SpeciesCode

checklistObservationObsId :: Lens' ChecklistObservation Text

checklistObservationObsDateTime :: Lens' ChecklistObservation EBirdDateTime

checklistObservationHowManyStr :: Lens' ChecklistObservation Text

subAuxSubId :: Lens' SubAux Text

subAuxFieldName :: Lens' SubAux Text

subAuxEntryMethodCode :: Lens' SubAux Text

subAuxAuxCode :: Lens' SubAux Text

subAuxEventId :: Lens' SubAuxAI Integer

subAuxAIType :: Lens' SubAuxAI Text

subAuxAISubId :: Lens' SubAuxAI Text

subAuxAISource :: Lens' SubAuxAI Text

subAuxAIMethod :: Lens' SubAuxAI Text

checklistFeedEntryUserDisplayName :: Lens' ChecklistFeedEntry Text

checklistFeedEntryTime :: Lens' ChecklistFeedEntry EBirdTime

checklistFeedEntrySubId :: Lens' ChecklistFeedEntry Text

checklistFeedEntryNumSpecies :: Lens' ChecklistFeedEntry Integer

checklistFeedEntryLocationId :: Lens' ChecklistFeedEntry Text

checklistFeedEntryLocationData :: Lens' ChecklistFeedEntry LocationData

checklistFeedEntryDate :: Lens' ChecklistFeedEntry EBirdDate

locationDataSubnational2Name :: Lens' LocationData Text

locationDataSubnational2Code :: Lens' LocationData Region

locationDataSubnational1Name :: Lens' LocationData Text

locationDataSubnational1Code :: Lens' LocationData Region

locationDataName :: Lens' LocationData Text

locationDataLongitude :: Lens' LocationData Double

locationDataLatitude :: Lens' LocationData Double

locationDataIsHotspot :: Lens' LocationData Bool

locationDataHeirarchicalName :: Lens' LocationData Text

locationDataCountryName :: Lens' LocationData Text

locationDataCountryCode :: Lens' LocationData Region

attoparsec parsers

parseSortChecklistsBy :: Parser SortChecklistsBy

Parse a SortChecklistsBy value