52
Copyright © 2010 Open Geospatial Consortium NoApplicableCode
No other exceptionCode specified by this service and server applies to this exception
None, omit “locator” parameter
NOTE The values listed above are copied from Table 20 in Subclause 8.3 of [OGC 06-121r3].
14 DescribeKey operation optional
14.1 Introduction
The DescribeKey operation returns an XML document that identifies all of the keys for a spatial framework to which data can be joined by the service instance. This description
also includes descriptive information about the spatial framework. This listing can be used to debug the JoinData operation, or to build a new attribute dataset for the spatial
framework. This operation shall be supported for all servers that implement data joining, as identified
in section 6.1.2.
14.2 DescribeKey operation request
14.2.1 DescribeKey request parameters
A request to perform the DescribeKey operation shall include the parameters listed in Table 64. This table also specifies the source of values and multiplicity of each listed
parameter, plus the meaning to servers when each optional parameter is not included in the operation request.
Table 64 — Parameters in DescribeKey operation request
Names Definition
Data type and values Multiplicity and use
service Service type identifier
Character String type, not empty Value is “TJS”
One mandatory request
Operation name Character String type, not empty
Value is “DescribeKey” One mandatory
version Service version
identifier Character String type, not empty
Value is “1.0” Zero or one optional
When included, return the matching version
When omitted, return latest supported
version language
Language identifier for human readable text
Character String type, not empty Value is a two or five character
IETF RFC 4646 language identifier
Zero or one optional For use see section 7.6
Framework URI
The URI of the spatial framework.
URI type Value is a FrameworkURI found
in the DescribeJoinAbilities response.
One mandatory
NOTE 1 The parameters shaded in gray above are largely copied from Table 3 of this document.
Copyright © 2010 Open Geospatial Consortium
53
14.2.2 DescribeKey request KVP encoding
mandatory
Servers shall implement HTTP GET transfer of the DescribeKey operation request, using KVP encoding. The KVP encoding of this request shall use the parameters specified in
Table 64.
EXAMPLE An example DescribeKey operation request KVP encoded for HTTP GET is:
http:foo.barfoo? Service=TJS
Version=1.0 Request=DescribeKey
FrameworkURI=http:foo.barfoo Language=en-CA
NOTE: For clarity, the parameter values in the above example have not been URL encoded.
14.2.3 DescribeKey request XML encoding
optional
Servers may also implement HTTP POST transfer of the DescribeKey operation request, using XML encoding only, in accordance with the tjsDescribeKey_request.xsd XML
schema.
14.3 DescribeKey operation response
