You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 26 Next »

Examples

Kevin: Add working URLs showing examples of the service in action.

Parameters


Collections

For the EBIRD dataService, only the EBIRD data collection will be available initially (i.e., all the data used for unrestricted, normal eBird clones). When the eBird application begins to use this API to generate frequency histograms, we will need to expand the list of EBIRD collections to include DOD, CKWRI, GCBO. The reason for this is that these clones use datasets other than the standard unrestricted eBird dataset that most clones for their output.





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


  • 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
  • multiple 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

BBS

none

 

 

 

 

 

 

 

species

  • optional
  • data for multiple species may be requested by including a species=value parameter fro every species of interest

species

deployed

Specifies species of interest.

  • Request species data using scientific name.

Sialia sialis

all

 

 

 

 

 

 

 

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 
    "xml"

ht-full

csv

 

 

 

 

 

 

 

output

optional

output

"f" implemented; "c" not implemented

What to return as values in csv and xml formats.

  • "f" = returns frequency## A year's data is divided into 48 time periods, 4 time periods for each month.
    1. An empty field represents no data available for that time period
    2. A field containing a "P" indicates the bird was reported on a checklist, but the checklist was not reporting all species.
    3. A field containing a "0" indicates that checklists were submitted for that time period, but that the species was not reported.
    4. 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. * "c" = returns category (integer, 1-5)

f

f

 

 

 

 

 

 

 

locale

optional

locale

not implemented

  • defines language to use for common names
  • Java standard locale code

en_US

en_US

 

 

 

 

 

 

 
  • No labels