...
parameter group | description | parameter name | implementation status | values | example value | default | |||
|---|---|---|---|---|---|---|---|---|---|
service | required | dataService | deployed | The public service requires 'dataService=AKN', the internal eBird service requires 'dataService=EBIRD' | dataService= AKN | none | |||
location | exactly two location parameters are required | location | deployed | One of eBird standard subnational1 codes , 2-letter ISO codes, integers 1-66, ebird subnat2 codes | US-FL | n/a none | |||
| required | locationType | deployed | One of subnational1,country,bcr,subnational2 | n/a |
|
| subnational1 | none |
|
|
|
|
|
|
| |||
period |
|
|
|
|
|
| |||
| optional | beginYear | deployed | defines beginning of period of interest, in YYYY format | 2000 | 1900 | |||
| optional | endYear | deployed | defines end of period of interest, in YYYY format | 2000 | 2008 (i.e., current year) | |||
|
|
|
|
|
|
| |||
collection |
| collection | deployed (single collection); support for multiple collections not yet deployed/implemented | AKN collection codes, eBird project IDs; initially there will be no away to request the entirety of AKN data as a collection | EBIRD_PR,BBS | n/a none | |||
|
|
|
|
|
| species | |||
| defines species of interest | optional | species | not implemented |
| Sialia sialis | all | |||
|
|
|
|
|
|
| |||
format | optional | format | not implemented | What format is response? | csv | csv | |||
|
|
|
|
|
|
| |||
output | defines form of output | optional | output | "f" implemented; "c" not implemented |
| "i" = returns image for single species; valid only when single species is requested; implemented at a later date f | f f | ||
|
|
|
|
|
|
| |||
locale |
optional | locale | not implemented
| * defines language to use for common names
...
- Java standard locale code
| en_US
...
- | en_US |
CSV Format Output (or tab delimited)
...