TJS DescribeFrameworks Operation

geoprocessing.info

Home  |  Terms of use

TJS DescribeFrameworks Operation


The DescribeFrameworks operation returns an XML document that identifies all of the spatial frameworks for which data is available from the service instance. This description includes information that uniquely identifies each spatial framework for which data is available from the service instance, and descriptive information about each framework. This description can be used to automatically build a user interface to identify the spatial framework for which the user would like to obtain attribute data.


DescribeFrameworks Request

Parameters

Name Presence Description
service Required Identifies service type. Must be "TJS".
request Required Identifies service request. Must be "DescribeFrameworks".
version Optional Identifies service version. Defaults to the latest available version, currently 1.0.
language Optional Determines the language of the human-readable content of the response. Value is a two or five character IETF RFC 4646 language identifier.
FrameworkURI Optional URI of a spatial framework to which the attribute data can be joined. 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.

Methods

HTTP GET method using KVP (mandatory)

All TJS servers shall implement HTTP GET transfer of the DescribeFrameworks request, using KVP encoding. The KVP encoding of the DescribeFrameworks request shall use the parameters specified above. An example of a DescribeFrameworks request via HTTP GET is:

http://foo.bar/foo?
   service=TJS&
   request=DescribeFrameworks&
   version=1.0&
   language=en


HTTP POST method using XML (optional)

TJS servers may also implement HTTP POST transfer of the DescribeFrameworks operation request, using XML encoding only. The request parameters are encoded as XML elements, with their contents identical to those indicated in the parameter table shown above according to the DescribeFrameworks request XML schema. The following example indicates the contents and structure of a DescribeFrameworks operation request encoded in XML.

<DescribeFrameworks service="TJS" version="1.0" language="en"/>



DescribeFrameworks Response

Schema

The normal response to a valid DescribeFrameworks operation request shall be a FrameworkDescriptions data structure, which contains descriptions of one or more Frameworks for which data is available on this service. This document is encoded in XML according to the DescribeFrameworks response XML schema.

Examples


Exceptions

When a TJS server encounters an error while performing a DescribeFrameworks 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].


For more information on structuring requests, please see the TJS Standard.