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 |
---|---|
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"?> | Header information includes the AKN COVAR_SPAT DTD |
Response to a well-formed metadata request
Example Value | Description |
---|---|
<?xml version="1.0" encoding="UTF-8"?> | Header information includes the AKN COVAR_SPAT DTD |