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

Compare with Current View Page History

« Previous Version 30 Next »


  

The service and discovery URLs provide basic information describing and listing the COVAR_SPAT data layer values that are available via the AKN web service. A layer list request returns the entire list of COVAR_SPAT and COVAR_FRAGSTAT attribute names. A metadata request returns a descriptive record for the requested attribute. Both the layer listing request and the metadata request will accept a format parameter that specifies a response data format of XML or CSV.

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

Metadata Request

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

Deployed URLs

Expected Response

http://www.avianknowledge.net/ws1.0/ref/covar/list

The entire list of active COVAR layers in CSV format

http://www.avianknowledge.net/ws1.0/ref/covar/list?format=xml

The entire list of active COVAR layers in XML format

http://www.avianknowledge.net/ws1.0/ref/covar/metadata?match=caus_prec0101&format=csv

The metadata for the CAUS_PREC0101 layer in CSV format

http://www.avianknowledge.net/ws1.0/ref/covar/metadata?match=caus_prec0101&format=xml

The metadata for the CAUS_PREC0101 layer in XML format

XML Result Formats

Response to a well-formed listing request

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 containing the <field-name>, a <descriptive-name>, and the <source-table-name> element

Response to a well-formed metadata request

Response to a mal-formed metadata request

CSV Result Formats

Response to a well-formed listing request

Response to a mal-formed listing request

Response to a well-formed metadata request

Response to a mal-formed metadata request

  • No labels