Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

parameter group

description

parameter name

values

example

default

location

  • exactly one location parameter is required

subnational1

eBird standard subnational1 codes

US-FL

n/a

 

 

country

2-letter ISO codes

CA

n/a

 

 

bcr

integers 1-64?

14

n/a

 

 

subnational2

eBird standard subnational2 codes

US-TN-185

n/a

 

 

 

 

 

 

period

  • period parameters are optional
  • if specified, both must be provided
  • constraint beginYear <= endYear

 

 

 

 

 

 

beginYear

defines beginning of period of interest, in YYYY format

2000

???? 1900

 

 

endYear

defines end of period of interest, in YYYY format

2000 ????

2008 (i.e., current year)

 

 

 

 

 

 

collection

  • defines dataset of interest
  • required

collection

AKN collection codes, eBird project IDs; initially there will be no away to request the entirety of AKN data as a collection

EBIRD_PR

n/a

 

 

 

 

 

 

species

  • defines species of interest
  • optional

species

either "all" or scientific name of single species of interest; we will handle lists of species at a later date

Sialia sialis

all

 

 

 

 

 

 

output

  • defines form of output
  • optional

output

"f" = returns frequency (float, 0.0-1.0)
"c" = returns category (integer, 1-5)
"i" = returns image for single species; valid only when single species is requested; implemented at a later date

f

f

 

 

 

 

 

 

locale

  •  defines language to use for common names
  • optional

locale

Java standard locale codes code

en_US

en_US

 

 

 

 

 

 

Supporting web services needed

...