Versions Compared

Key

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

...

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


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

 

 

 

 

 

 

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

  • defines dataset(s) of interest
  • required
  • may be comma separated list of collection codes

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
sample AKN
valid collection codes for AKN dataService:
ARCTICSURVEY, BBS, Banding, GBBC, HawkCount, KBMNPC, LACP, LBMP, MBW, MMP, PFW, PIF_CA_AREA, PIF_CA_PC, PRBO-PC, RMBO-SS, RMBO_PT,  
sample eBird collection codes:
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

EBIRD_PR,BBS

n/a none

 

 

 

 

 

 

species  

defines

species

of interest

optional

species

not implemented

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

Sialia sialis

all

 

 

 

 

 

 

 

format

optional

format

not implemented

What format is response?
"csv" = comma separated values
"img" = returns image for single species; valid only when single species is requested; implemented at a later date
"xml"

csv

csv

 

 

 

 

 

 

 

output

defines form of

output

optional

output

"f" implemented; "c" not implemented

  • What to return as values in csv and xml formats.
  • "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 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)

...