Copyright | (c) 2023 Finley McIlwaine |
---|---|
License | MIT (see LICENSE) |
Maintainer | Finley McIlwaine <finleymcilwaine@gmail.com> |
Safe Haskell | Safe-Inferred |
Language | Haskell2010 |
Types related to eBird checklist API values.
Synopsis
- data Checklist = Checklist {
- _checklistProjectId :: Text
- _checklistSubId :: Text
- _checklistProtocolId :: Text
- _checklistLocationId :: Text
- _checklistGroupId :: Text
- _checklistDurationHours :: Maybe Double
- _checklistAllObsReported :: Bool
- _checklistCreationDateTime :: EBirdDateTime
- _checklistLastEditedDateTime :: EBirdDateTime
- _checklistObsDateTime :: EBirdDateTime
- _checklistObsTimeValid :: Bool
- _checklistChecklistId :: Text
- _checklistNumObservers :: Integer
- _checklistEffortDistanceKm :: Maybe Double
- _checklistEffortDistanceEnteredUnit :: Maybe Text
- _checklistSubnational1Code :: Region
- _checklistSubmissionMethodCode :: Text
- _checklistSubmissionMethodVersion :: Text
- _checklistSubmissionMethodVersionDisp :: Text
- _checklistUserDisplayName :: Text
- _checklistNumSpecies :: Integer
- _checklistSubAux :: [SubAux]
- _checklistSubAuxAI :: [SubAuxAI]
- _checklistObs :: [ChecklistObservation]
- data ChecklistObservation = ChecklistObservation {}
- data SubAux = SubAux {}
- data SubAuxAI = SubAuxAI {}
- data ChecklistFeedEntry = ChecklistFeedEntry {}
- data LocationData = LocationData {
- _locationDataName :: Text
- _locationDataLatitude :: Double
- _locationDataLongitude :: Double
- _locationDataCountryCode :: Region
- _locationDataCountryName :: Text
- _locationDataSubnational1Code :: Region
- _locationDataSubnational1Name :: Text
- _locationDataSubnational2Code :: Region
- _locationDataSubnational2Name :: Text
- _locationDataIsHotspot :: Bool
- _locationDataHeirarchicalName :: Text
- data SortChecklistsBy
- 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
- parseSortChecklistsBy :: Parser SortChecklistsBy
Checklist types
Values returned by the ViewChecklistAPI
Checklist | |
|
Instances
data ChecklistObservation Source #
Observation values included in checklists.
ChecklistObservation | |
|
Instances
Values included in the checklistSubAux
field of Checklist
s.
SubAux | |
|
Instances
Read SubAux Source # | |
Show SubAux Source # | |
Eq SubAux Source # | |
FromJSON SubAux Source # | Explicit instance for compatibility with their field names |
ToJSON SubAux Source # | Explicit instance for compatibility with their field names |
Defined in Data.EBird.API.Checklists | |
(k ~ A_Lens, a ~ Text, b ~ Text) => LabelOptic "auxCode" k SubAux SubAux a b Source # | |
Defined in Data.EBird.API.Checklists | |
(k ~ A_Lens, a ~ Text, b ~ Text) => LabelOptic "entryMethodCode" k SubAux SubAux a b Source # | |
Defined in Data.EBird.API.Checklists | |
(k ~ A_Lens, a ~ Text, b ~ Text) => LabelOptic "fieldName" k SubAux SubAux a b Source # | |
Defined in Data.EBird.API.Checklists | |
(k ~ A_Lens, a ~ Text, b ~ Text) => LabelOptic "subId" k SubAux SubAux a b Source # | |
Defined in Data.EBird.API.Checklists |
Values included in the checklistSubAuxAI
field of Checklist
s.
SubAuxAI | |
|
Instances
Read SubAuxAI Source # | |
Show SubAuxAI Source # | |
Eq SubAuxAI Source # | |
FromJSON SubAuxAI Source # | Explicit instance for compatibility with their field names |
ToJSON SubAuxAI Source # | Explicit instance for compatibility with their field names |
Defined in Data.EBird.API.Checklists | |
(k ~ A_Lens, a ~ Text, b ~ Text) => LabelOptic "method" k SubAuxAI SubAuxAI a b Source # | |
Defined in Data.EBird.API.Checklists | |
(k ~ A_Lens, a ~ Text, b ~ Text) => LabelOptic "source" k SubAuxAI SubAuxAI a b Source # | |
Defined in Data.EBird.API.Checklists | |
(k ~ A_Lens, a ~ Text, b ~ Text) => LabelOptic "subId" k SubAuxAI SubAuxAI a b Source # | |
Defined in Data.EBird.API.Checklists | |
(k ~ A_Lens, a ~ Text, b ~ Text) => LabelOptic "type" k SubAuxAI SubAuxAI a b Source # | |
Defined in Data.EBird.API.Checklists |
data ChecklistFeedEntry Source #
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
).
ChecklistFeedEntry | |
|
Instances
data LocationData Source #
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
).
LocationData | |
|
Instances
Auxiliary eBird checklist-related API types
data SortChecklistsBy Source #
How to rank the list returned by the Top100API
.
SortChecklistsByDateCreated | Sort checklists by the date of the observations they contain |
SortChecklistsByDateSubmitted | Sort checklists by the date they were submitted |
Instances
IsString SortChecklistsBy Source # | Use this instance carefully! It throws runtime exceptions if the string is malformatted. |
Defined in Data.EBird.API.Checklists fromString :: String -> SortChecklistsBy # | |
Read SortChecklistsBy Source # | |
Defined in Data.EBird.API.Checklists | |
Show SortChecklistsBy Source # | |
Defined in Data.EBird.API.Checklists showsPrec :: Int -> SortChecklistsBy -> ShowS # show :: SortChecklistsBy -> String # showList :: [SortChecklistsBy] -> ShowS # | |
EBirdString SortChecklistsBy Source # | The eBird string for a |
Defined in Data.EBird.API.Checklists | |
Eq SortChecklistsBy Source # | |
Defined in Data.EBird.API.Checklists (==) :: SortChecklistsBy -> SortChecklistsBy -> Bool # (/=) :: SortChecklistsBy -> SortChecklistsBy -> Bool # | |
ToHttpApiData SortChecklistsBy Source # | |
Defined in Data.EBird.API.Checklists |
Optics for checklist types
attoparsec parsers
parseSortChecklistsBy :: Parser SortChecklistsBy Source #
Parse a SortChecklistsBy
value