Examples
Kevin: Add working URLs showing examples of the service in action.
API Parameters
Note | ||
---|---|---|
| ||
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 |
| dataService | deployed |
| AKN | none |
location |
| location | deployed |
| US-FL | none |
|
| locationType | deployed |
| subnational1 | none |
|
|
|
|
|
|
|
period |
|
|
|
|
|
|
|
| beginYear | deployed |
| 2000 | 1900 |
|
| endYear | deployed |
| 2000 | 2008 (i.e., current year) |
|
|
|
|
|
|
|
collection |
| collection | deployed |
| BBS | none |
|
|
|
|
|
|
|
species |
| species | deployed |
| Sialia sialis | all |
|
|
|
|
|
|
|
format |
| format | deployed |
| jsdoc | htfull |
|
|
|
|
|
|
|
output |
| output | deployed |
| f | f |
|
|
|
|
|
|
|
locale |
| locale | not implemented |
| en_US | en_US |
|
|
|
|
|
|
|
jsFunctionName | specifies the name of the javascript function to be returned | jsFunctionName | deployed | Used only when format=jsfunc. This parameter specifies the name of the function that is to be defined in the JavaScript file that is returned. Not required. | myFreqChart | AKNFreqHist |
Example URLs
...
Deployed URL | Response |
---|
...
Raw data in CSV format for the state of Maine, all collections. | |
Result data in fully formatted HTML for the state of Vermont, the Mountain Bird Watch collection. | |
Result data formatted for a JavaScript doc.write() call for the state of Pennsylvania, HawkCount and eBird collections. | |
Result data formatted for display by a Javascript function named showAKNBarChart. The data request is for the state of California, the PRBO Point Count collection. |
Response to a well-formed Frequency Histogram Request
Note | ||
---|---|---|
| ||
The number of header lines may need to be flexible to accommodate one line for each collection. Actual collection citations may need to be put into the header in this manner. |
Description |
---|
...
Note | ||
---|---|---|
| ||
The number of header lines may need to be flexible to accommodate one line for each collection. Actual collection citations may need to be put into the header in this manner. |
Description | Name | Line Number | Format | Example Value | ||
---|---|---|---|---|---|---|
Status | Status | 1 | Text terminated by a newline | DATA | ||
Header | Copyright | 2 | Text terminated by a newline | Copyright 2008 Cornell Lab of Ornithology http://www.birds.cornell.edu | ||
| Data Policy | 3 | Text terminated by a newline | AKN Data Sharing Policy http://www.avianknowledge.net/content/about/akn-data-sharing-policy | ||
| Number of records returned | 4 | Text terminated by a newline | RECORD COUNT=316 | ||
Separator | Blank Line | 5 | newline |
| ||
Sample Size | Sample Size | 6 through S (S - 1 = number of collections included in response, line S is the TOTAL sample size) | Comma delimited text, terminated by a newline. The first field contains the Collection Code, the second field contains the string "Sample Size," followed by 48 integer values. | EBIRD,Sample Size,64,44,58,96,57,64,100,65,78,133,113,145,111,119,122,152,83,95,120,161,94,73,72,129,117,58,69,105,57,51,53,77,64,68,78,77,51,83,88,162,94,60,71,76,55,43,99,123 | ||
Separator | Blank Line | S + 1 | newline |
| ||
Frequency Data | Data | S + 2 through N - 1 (N = RECORD COUNT) | Comma delimited text, terminated by a newline
| Common Goldeneye,Bucephala clangula,0.078125,0.02272,0.103448,0.083,0.122,0.078,0.079,0.061,0.089,0.11278,0.123,0.089,0.0360,0.0168,0.0327,0.0328,0,0.04210,0.0083,0,5.3106744E-4,5.4010E-4,6.7009E-4,3.346720E-4,7.0871E-4,0.01612,P,0,0,0.01960,P,0,0,0.014705,0,0,0,0,0.0113,0.0061,0.0106,0.016,0.028,0.039,0.090,0.09,0.24,0.19 |
...
No Format |
---|
function AKNFreqHist () { return '<link rel="stylesheet" type="text/css" href="http://akn.ornith.cornell.edu/styles/histogram.css" /><table class="obs-histogram"><thead><tr><td class="sp" title=""></td><td>Jan</td><td>Feb</td><td>Mar</td><td>Apr</td><td>May</td><td>Jun</td><td>Jul</td><td>Aug</td><td>Sep</td><td>Oct</td><td>Nov</td><td>Dec</td></tr></thead><tbody></tr><tr id="sp305" class="o""><td class="sp" title="Passer domesticus">House Sparrow</td><td><img src="http://akn.ornith.cornell.edu/images/no.gif"no.gif" /><img src="http://akn.ornith.cornell.edu/images/no.gif" /><img src="http://akn.ornith.cornell.edu/images/no.gif" /><img src="http://akn.ornith.cornell.edu/images/no.gif" /></td><td><img src="http://akn.ornith.cornell.edu/images/no.gif" /><img src="http://akn.ornith.cornell.edu/images/no.gif" /><img src="http://akn.ornith.cornell.edu/images/no.gif" /><img src="http://akn.ornith.cornell.edu/images/no.gif" /></td><td><img src="http://akn.ornith.cornell.edu/images/no.gif"no.gif" /><img src="http://akn.ornith.cornell.edu/images/no.gif" /><img src="http://akn.ornith.cornell.edu/images/no.gif" /><img src="http://akn.ornith.cornell.edu/images/03.gif" /></td><td><img src="http://akn.ornith.cornell.edu/images/03.gif" /><img src="http://akn.ornith.cornell.edu/images/03.gif" /><img src="http://akn.ornith.cornell.edu/images/03.gif" /><img src="http://akn.ornith.cornell.edu/images/03.gif" /></td><td><img src="http://akn.ornith.cornell.edu/images/03.gif"03.gif" /><img src="http://akn.ornith.cornell.edu/images/03.gif" /><img src="http://akn.ornith.cornell.edu/images/03.gif" /><img src="http://akn.ornith.cornell.edu/images/03.gif" /></td><td><img src="http://akn.ornith.cornell.edu/images/05.gif" /><img src="http://akn.ornith.cornell.edu/images/05.gif" /><img src="http://akn.ornith.cornell.edu/images/05.gif" /><img src="http://akn.ornith.cornell.edu/images/05.gif" /></td><td><img src="http://akn.ornith.cornell.edu/images/09.gif"09.gif" /><img src="http://akn.ornith.cornell.edu/images/05.gif" /><img src="http://akn.ornith.cornell.edu/images/no.gif" /><img src="http://akn.ornith.cornell.edu/images/no.gif" /></td><td><img src="http://akn.ornith.cornell.edu/images/no.gif" /><img src="http://akn.ornith.cornell.edu/images/sp.gif" /><img src="http://akn.ornith.cornell.edu/images/sp.gif" /><img src="http://akn.ornith.cornell.edu/images/no.gif" /></td><td><img src="http://akn.ornith.cornell.edu/images/no.gif"no.gif" /><img src="http://akn.ornith.cornell.edu/images/no.gif" /><img src="http://akn.ornith.cornell.edu/images/no.gif" /><img src="http://akn.ornith.cornell.edu/images/no.gif" /></td><td><img src="http://akn.ornith.cornell.edu/images/no.gif" /><img src="http://akn.ornith.cornell.edu/images/no.gif" /><img src="http://akn.ornith.cornell.edu/images/no.gif" /><img src="http://akn.ornith.cornell.edu/images/no.gif" /></td><td><img src="http://akn.ornith.cornell.edu/images/no.gif"no.gif" /><img src="http://akn.ornith.cornell.edu/images/no.gif" /><img src="http://akn.ornith.cornell.edu/images/no.gif" /><img src="http://akn.ornith.cornell.edu/images/no.gif" /></td><td><img src="http://akn.ornith.cornell.edu/images/no.gif" /><img src="http://akn.ornith.cornell.edu/images/no.gif" /><img src="http://akn.ornith.cornell.edu/images/no.gif" /><img src="http://akn.ornith.cornell.edu/images/no.gif" /></td></tr></tbody></table>'; } |
...
No Format |
---|
document.write('<link rel="stylesheet" type="text/css" href="http://akn.ornith.cornell.edu/styles/histogram.css"histogram.css" /><table class="obs-histogram"><thead><tr><td class="sp" title=""></td><td>Jan</td><td>Feb</td><td>Mar</td><td>Apr</td><td>May</td><td>Jun</td><td>Jul</td><td>Aug</td><td>Sep</td><td>Oct</td><td>Nov</td><td>Dec</td></tr></thead><tbody></tr><tr id="sp305" class="o""><td class="sp" title="Passer domesticus">House Sparrow</td><td><img src="http://akn.ornith.cornell.edu/images/no.gif" /><img src="http://akn.ornith.cornell.edu/images/no.gif" /><img src="http://akn.ornith.cornell.edu/images/no.gif" /><img src="http://akn.ornith.cornell.edu/images/no.gif" /></td><td><img src="http://akn.ornith.cornell.edu/images/no.gif" /><img src="http://akn.ornith.cornell.edu/images/no.gif" /><img src="http://akn.ornith.cornell.edu/images/no.gif" /><img src="http://akn.ornith.cornell.edu/images/no.gif"no.gif" /></td><td><img src="http://akn.ornith.cornell.edu/images/no.gif" /><img src="http://akn.ornith.cornell.edu/images/no.gif" /><img src="http://akn.ornith.cornell.edu/images/no.gif" /><img src="http://akn.ornith.cornell.edu/images/03.gif" /></td><td><img src="http://akn.ornith.cornell.edu/images/03.gif" /><img src="http://akn.ornith.cornell.edu/images/03.gif" /><img src="http://akn.ornith.cornell.edu/images/03.gif" /><img src="http://akn.ornith.cornell.edu/images/03.gif"03.gif" /></td><td><img src="http://akn.ornith.cornell.edu/images/03.gif" /><img src="http://akn.ornith.cornell.edu/images/03.gif" /><img src="http://akn.ornith.cornell.edu/images/03.gif" /><img src="http://akn.ornith.cornell.edu/images/03.gif" /></td><td><img src="http://akn.ornith.cornell.edu/images/05.gif" /><img src="http://akn.ornith.cornell.edu/images/05.gif" /><img src="http://akn.ornith.cornell.edu/images/05.gif" /><img src="http://akn.ornith.cornell.edu/images/05.gif"05.gif" /></td><td><img src="http://akn.ornith.cornell.edu/images/09.gif" /><img src="http://akn.ornith.cornell.edu/images/05.gif" /><img src="http://akn.ornith.cornell.edu/images/no.gif" /><img src="http://akn.ornith.cornell.edu/images/no.gif" /></td><td><img src="http://akn.ornith.cornell.edu/images/no.gif" /><img src="http://akn.ornith.cornell.edu/images/sp.gif" /><img src="http://akn.ornith.cornell.edu/images/sp.gif" /><img src="http://akn.ornith.cornell.edu/images/no.gif"no.gif" /></td><td><img src="http://akn.ornith.cornell.edu/images/no.gif" /><img src="http://akn.ornith.cornell.edu/images/no.gif" /><img src="http://akn.ornith.cornell.edu/images/no.gif" /><img src="http://akn.ornith.cornell.edu/images/no.gif" /></td><td><img src="http://akn.ornith.cornell.edu/images/no.gif" /><img src="http://akn.ornith.cornell.edu/images/no.gif" /><img src="http://akn.ornith.cornell.edu/images/no.gif" /><img src="http://akn.ornith.cornell.edu/images/no.gif"no.gif" /></td><td><img src="http://akn.ornith.cornell.edu/images/no.gif" /><img src="http://akn.ornith.cornell.edu/images/no.gif" /><img src="http://akn.ornith.cornell.edu/images/no.gif" /><img src="http://akn.ornith.cornell.edu/images/no.gif" /></td><td><img src="http://akn.ornith.cornell.edu/images/no.gif" /><img src="http://akn.ornith.cornell.edu/images/no.gif" /><img src="http://akn.ornith.cornell.edu/images/no.gif" /><img src="http://akn.ornith.cornell.edu/images/no.gif" /></td></tr></tbody></table>'); |