DescribeFrameworks request parameters DescribeFrameworks request KVP encoding

Copyright © 2010 Open Geospatial Consortium 33 Capabilities XML document, which shall be as attached in the tjsCapabilitiesContents .xsd file. All these XML Schema Documents contain documentation of the meaning of each element, attribute, and type, and this documentation shall be considered normative as specified in Subclause 11.6.3 of [OGC 06-121r3].

8.3.6 Exceptions

When a TJS server encounters an error while performing a GetCapabilities operation, it shall return an exception report message as specified in Clause 8 of [OGC 06-121r3]. The allowed exception codes shall include those listed in Table 5 of Subclause 7.4.1 of [OGC 06-121r3]. 9 DescribeFrameworks operation optional

9.1 Introduction

The DescribeFrameworks operation returns an XML document that describes one or more spatial frameworks for which data is available from the server. This description includes information that uniquely identifies each spatial framework, and descriptive information about each framework. This information can be used to populate a user interface to identify the spatial framework for which the user would like to obtain attribute data. When the optional FrameworkURI parameter is included, the response can be used to populate an “about” page for a specific framework. This operation shall be supported for all servers that implement data access, as identified in section 6.1.1.

9.2 DescribeFrameworks operation request

9.2.1 DescribeFrameworks request parameters

A request to perform the DescribeFrameworks operation shall include the parameters listed in Table 41. 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. 34 Copyright © 2010 Open Geospatial Consortium Table 41 — Parameters in DescribeFrameworks 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 “DescribeFrameworks” 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 URI of a spatial framework to which the attribute data can be joined. URI type, not empty Value is a URI as found in the DescribeFrameworks response. Zero or one optional a a The list of frameworks supported by a server is normally unknown during an initial DescribeFrameworks request to a server, and therefore this parameter is normally absent during such a request. If this parameter is absent, the response shall include descriptions for all frameworks for which data access is supported by the server. NOTE 1 The parameters shaded in gray above are largely copied from Table 3 in Subclause 7.3 of this document.

9.2.2 DescribeFrameworks request KVP encoding

mandatory Servers shall implement HTTP GET transfer of the DescribeFrameworks operation request, using KVP encoding. The KVP encoding of this request shall use the parameters specified in Table 41. EXAMPLE An example DescribeFrameworks operation request KVP encoded for HTTP GET is: http:foo.barfoo? Service=TJS Version=1.0 Request=DescribeFrameworks Language=en-CA

9.2.3 DescribeFrameworks request XML encoding