You are viewing an old version of this page. View the current version.
Compare with Current
View Page History
« Previous
Version 33
Next »
API Parameters
Layer List Request
URL |
Description |
Status |
Notes |
/ws1.0/ref/covar/list |
Returns the entire list of COVAR_SPAT and COVAR_FRAGSTAT layers |
Deployed |
|
Parameter |
Required |
Default |
Values |
Example |
Description |
format |
no |
csv |
"xml" or "csv" |
format=xml |
Format specification for data response |
URL |
Description |
Status |
Notes |
/ws1.0/ref/covar/metadata?match=<layer_name> |
Metadata request for a specific COVAR layer |
Deployed |
|
Parameter |
Required |
Default |
Values |
Example |
Description |
match |
yes |
|
Any valid COVAR_SPAT or COVAR_FRAGSTAT layer name |
match=caus_prec0101 |
Layer parameter for metadata request |
format |
no |
csv |
"xml" or "csv" |
format=xml |
Format specification for metadata request |
Example URLs
Example Value |
Description |
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE response PUBLIC "-//Avian Knowledge Network//DTD COVAR_SPAT 1.0//EN" "http://akn.ornith.cornell.edu/dtd/covar_spat_1_0.dtd">
<response>
<header>
<locale country="US" language="en"/>
<timestamp>2009-05-06T07:31:23.017-04:00</timestamp>
<criteria/>
<copyright>Copyright 2009 Cornell Lab of Ornithology - http://www.birds.cornell.edu</copyright>
<data-policy>AKN Data Sharing Policy - http://www.avianknowledge.net/content/about/akn-data-sharing-policy</data-policy>
<comment>Listing of COVAR_SPAT field names and source data tables</comment>
</header>
<result>
<covar-spat>
<covar-spat-metadata>
<data-record>
<attribute-data>
<field-name>AI</field-name>
<descriptive-name>Aggregation Index (Fragstats)</descriptive-name>
<source-table-name>COVAR_FS_CLASS_NLCD2001</source-table-name>
</attribute-data>
</data-record>
<data-record>
<attribute-data>
<field-name>AREA_AM</field-name>
<descriptive-name>Area-weighted mean patch area (Fragstats)</descriptive-name>
<source-table-name>COVAR_FS_CLASS_NLCD2001</source-table-name>
</attribute-data>
</data-record>
...
</covar-spat-metadata>
</covar-spat>
</result>
</response> |
Header information includes the AKN COVAR_SPAT DTD
The timestamp of the response
A copyright element
The AKN data sharing policy element
A comment element
The data listing is a series of <data-record> elements. Each <data-record> contains 1 <attribute-data> element containing the <field-name>, a <descriptive-name>, and the <source-table-name> elements. |
Example Value |
Description |
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE response PUBLIC "-//Avian Knowledge Network//DTD COVAR_SPAT 1.0//EN" "http://akn.ornith.cornell.edu/dtd/covar_spat_1_0.dtd">
<response>
<header>
<locale country="US" language="en"/>
<timestamp>2009-05-06T07:48:23.346-04:00</timestamp>
<criteria/>
<copyright>Copyright 2009 Cornell Lab of Ornithology - http://www.birds.cornell.edu</copyright>
<data-policy>AKN Data Sharing Policy - http://www.avianknowledge.net/content/about/akn-data-sharing-policy</data-policy>
<comment>COVAR_SPAT metadata response</comment>
</header>
<result>
<covar-spat>
<covar-spat-metadata>
<data-record>
<attribute-data>
<field-name>PLAND</field-name>
<descriptive-name>Percentage of landscape (Fragstats)</descriptive-name>
<description>PLAND = the sum of the areas of all patches of the corresponding patch type, divided by total landscape area, multiplied by 100</description>
<data-type>NUMBER</data-type>
<units>Number</units>
<min-value>Not Described</min-value>
<max-value>Not Described</max-value>
<min-value-description>Not Described</min-value-description>
<max-value-description>Not Described</max-value-description>
<nodata-value>-9999</nodata-value>
</attribute-data>
</data-record>
</covar-spat-metadata>
</covar-spat>
</result>
</response> |
Header information includes the AKN COVAR_SPAT DTD
The timestamp of the response
A copyright element
The AKN data sharing policy element
A comment element
The data listing is a series of <data-record> elements. Each <data-record> contains 1 <attribute-data> element containing the <field-name>, <descriptive-name>, <description>, <data-type>, <units>, <min-value>, <max-value>, <min-value-description>, <max-value-description>, and the <nodata-value> elements.
This particular example is for a Fragstats attribute. There are no set maximum or minimum values for this statistic so the value is set to "Not Described." The "Not Described value should be treated as NULL.
Some COVAR_SPAT values represent a value range. Many of the climate layers like precipitation and mean temperature will have both <min-value>, <max-value>, and <min-value-description> and <max-value-description> data elements. In these cases where the data for a particular point is a data range the <min-value>, and <max-value> are discrete values and the <min-value-description> and <max-value-description> describe the actual value range for the attribute. |