parameter group | description | parameter name
| implementation status | values | example value
| default |
|---|
service | required | dataService | deployed | AKN, EBIRD (i.e. this tells which warehouse to utilize)
| AKN | none |
location | required
| location | deployed | One of eBird standard subnational1 codes , 2-letter ISO codes, integers 1-66, ebird subnat2 codes
| US-FL | none |
| required | locationType | deployed | One of subnational1,country,bcr,subnational2 | subnational1
| none |
| | | | | | |
period |
- Defines a specific period of interest
- if specified, both must be provided
- constraint beginYear <= endYear
| | | | | |
| | beginYear | deployed | defines beginning year of period of interest , in YYYY format
| 2000 | 1900 |
| | endYear | deployed | defines end year of period of interest , in YYYY format | 2000 | 2008 (i.e., current year)
|
| | | | | | |
collection | - defines dataset(s) of interest
- requiredmultiple
| collection codes may be requested by including a collection=value parameter for every collection of interest
| collection
| deployed
| - AKN collection codes, eBird project IDs; initially there will be no away to request the entirety of AKN data as a collection
- valid collection codes for AKN dataService:
All, ARCTICSURVEY, BBS, Banding, GBBC, HawkCount, KBMNPC, LACP, LBMP, MBW, MMP, PFW, PIF_CA_AREA, PIF_CA_PC, PRBO-PC, RMBO-SS, RMBO_PT, EBIRD, EBIRD_AK, EBIRD_BCN, EBIRD_CA, EBIRD_CAN, EBIRD_CBW, EBIRD_CUBA, EBIRD_GCBO, EBIRD_HISP, EBIRD_KLAM_SISK, EBIRD_LWBA, EBIRD_MA, EBIRD_MEX, EBIRD_NY, EBIRD_PR, EBIRD_PRIMIG, EBIRD_TX, EBIRD_USVI, EBIRD_VT, EBIRD_WI - valid collection codes for EBIRD dataservice:
EBIRD - multiple collection codes may be requested by including a collection=value parameter for every collection of interest
| BBS | none |
| | | | | | |
species | - Specifies species of interest.
- optional
| species | deployed
| - Request species data using scientific name.
- data for multiple species may be requested by including a species=value parameter fro every species of interest
| species | deployed
| Specifies .- Request species data using scientific name.
| Sialia sialis
| all |
| | | | | | |
format | - Specify response format.
- optional
| format
| deployed
Specify response format. | - "csv" = comma separated values
- "ht-full" = Response is a hypertext document
- "ht-frag" = Response is a hypertext <table> structure (usage: to be included inside an HTML wrapper)
- Not yet implemented: "img" = returns image for single species; valid only when single species is requested
- Not yet implemented: "xml"
| ht-full | csv |
| | | | | | | output | optional |
output | deployed
| - What to return as values in csv and xml formats.
- optional
| output | deployed
| - "f" = returns frequency data
- A year's data is divided into 48 time periods, 4 time periods for each month.
- An empty field represents no data available for that time period
- A field containing a "P" indicates the bird was reported on a checklist, but the checklist was not reporting all species.
- A field containing a "0" indicates that checklists were submitted for that time period, but that the species was not reported.
- A field containing a numeric value greater than 0 and less than or equal to 1 indicates the frequency of positive sightings for that time period.
- Not yet implemented: "c" = returns category (integer, 1-5)
| f | f |
| | | | | | | locale | optional |
locale
not implemented | - defines language to use for common names
- optional
| locale
| not implemented
|
- Java standard locale code
| en_US | en_US
|
| | | | | | |
