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

Compare with Current View Page History

« Previous Version 16 Next »

Parameters

parameter group

description

parameter name

values

example

default

service

  • required

dataService

The public service requires 'dataService=AKN', the internal eBird service requires 'dataService=EBIRD'

dataService=AKN

none

location

  • exactly two location parameters are required

location

One of eBird standard subnational1 codes , 2-letter ISO codes, integers 1-66, ebird subnat2 codes

US-FL

n/a

 

 

locationType

One of subnational1,country,bcr,subnational2


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

sample AKN collection codes:
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

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 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
  • No labels