The data retrieval URL, a find request, provides access to COVAR_SPAT and COVAR_FRAGSTAT layer data via latitude/longitude parameters, or a global unique identifier parameter for a single observation record. The find request will accept parameters to query for a single COVAR layer value, all layers in a specific COVAR table, or all layer values in the COVAR schema for a particular lat/lon or GlobalUniqueID. A find request will also accept a format parameter that specifies a response data format of XML or CSV.
API Parameters
Find Request
URL |
Description |
Status |
Notes |
|---|---|---|---|
ws1.0/data/covar/find?decLon=<lon>&decLat=<lat>&format=xml |
Returns all COVAR_SPAT and COVAR_FRAGSTAT layer values for lat/lon in XML format |
Deployed |
|
ws1.0/data/covar/find?guid=<guidValue> |
Returns all COVAR_SPAT and COVAR_FRAGSTAT layer values for guidValue in CSV format |
Deployed |
|
Parameter |
Required |
Default |
Values |
Example |
Description |
|---|---|---|---|---|---|
format |
no |
csv |
"xml" or "csv" |
format=xml |
Format specification for data response |
XML Result Formats
Response to a well-formed find request
Example Value |
Description |
|---|---|
|
|
Response to a mal-formed find request
Example Value |
Description |
|---|---|
|
|
CSV Result Formats
Response to a well-formed find request
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 2009 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 |
|
Field Listing |
Field Listing |
6 |
Comma separated text terminated by a newline |
FIELD NAME, DESCRIPTIVE NAME, SOURCE TABLE NAME |
Field data |
Field data |
7 to end of data |
Comma separated text terminated by a newline |
AI, Aggregation Index (Fragstats), COVAR_FS_CLASS_NLCD2001 |
Response to a mal-formed find request
Description |
Name |
Line Number |
Format |
Example Value |
|---|---|---|---|---|
Status |
Status |
1 |
Text terminated by a newline |
ERROR |
Header |
Request Parameters |
2 |
Text terminated by a newline |
REQUEST PARAMETERS=format=csv&match= |
|
Errors |
3 - N |
Text terminated by a newline |
A well-formed metadata request includes a match=layer_name query parameter (i.e. match=CAUS_PREC0101). |
Separator |
Blank Line |
N + 1 |
newline |
|