View Source

Parameters

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'	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 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 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, 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	none

species	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	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)	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)

The output is broken up into two parts:
- header
  - Contains N lines of text, where N is as large as needed to hold AKN-approved attribution and branding info.
  - Each line of text is treated as a single CSV field, which means it must be enclosed by double quotes, if it contains commas.
  - Should this header data be plain text or HTML?
  - If multiple header lines are included, the expectation are that they would be each turned into one paragraph in a presentation of the data. E.g. line #1 ==> paragraph #1.
- blank line, to separate header and data
- data

- - if S species are returned, the data part of the response has S+1 rows
    - row 1 contains N for each of 48 "weeks"
    - rows 2 through S+1 contain species name and frequency (0 <= frequency <= 1)

- - the data part of the response contains 50 columns
    - column 1 :: sci. name
    - column 2 :: common name
    - columns 3-50 :: frequency or category