deegree Configuration services allow a client to apply basic configuration operations to deegree Web Services. The current API and implementation covers WMS layers and styles, WFS feature types, and geospatial data in a PostGIS instance.

Index

Contents

geodb-conf
1. CreateDataSource Operation
  1. CreateDataSource Request
  2. CreateDataSource Response
2. RemoveDataSource Operation
  1. RemoveDataSource Request
  2. RemoveDataSource Response
wfs-conf
1. AddFeatureType Operation
  1. AddFeatureType Request
  2. AddFeatureType Response
2. RemoveFeatureType Operation
  1. RemoveFeatureType Request
  2. RemoveFeatureType Response
wms-conf

Web Service API

The deegree Configuration Services API currently defines three services: geodb-conf for data source manipulation (PostGIS), wfs-conf for feature type manipulation (WFS), and wms-conf for layer / style manipulation (WMS).

All operations are available via HTTP GET only. Please refer to the OGC Web Services Common Specification (OGC 05-008), section 11.2, for more detailed information on request handling.

Upon receiving an invalid operation request, each service shall respond to the client using an Exception Report message to describe to the client application and/or its human user the reason(s) that the request is invalid. Whenever a server detects an exception condition while responding to a valid operation request, and cannot produce a normal response to that operation, the server shall also respond to the client using an Exception Report. Please refer to the OGC Web Services Common Specification (OGC 05-008), section 8, for more detailed information on exception handling.

1. geodb-conf

The geodb-conf service allows a client to create or remove a template-driven structure of tables in a geospatial database (currently supported: PostGIS).

1.1. CreateDataSource Operation

The CreateDataSource operation allows a client to create a data source in a geospatial database. The structure of the data source is defined by a template which is referenced by name. Future extension: Available templates are advertised in the service's GetCapabilities response.

1.1.1. CreateDataSource Request

Request Parameter	Mandatory / Optional	Description
REQUEST=createDataSource	M	Request name
NAME=aname	M	Datastore name. Allowed characters: [a-z], "_"
TITLE=atitle	O	A human-readable string for presentation in a menu (default: empty string).
ABSTRACT=anabstract	O	Abstract is a narrative description of the data source (default: empty string).
CRS=namespace:identifier	M	Coordinate reference system.
BBOX=minx,miny,maxx,maxy	M	Bounding box corners (lower left, upper right) in CRS units.
TEMPLATE=atemplate	M	Name of the template to be used for data source creation.

Example request:

http://a.server.org/geodb-conf?
  request=CreateDataSource
  &name=Baustellen
  &crs=EPSG:31466
  &bbox=2570850,5670700,2591781,5687791
  &template=tmpl_bonn_1

1.1.2. CreateDataSource Response

In response to a valid CreateDataSource request, a geodb-conf service shall generate an XML document indicating the termination status of the transaction. The following XML fragment defines the XML encoding of the CreateDataSource response:

    <CreateDataSourceResponse>
        <summary result="Added feature type baustellen">
        </summary>
    </CreateDataSourceResponse>

An invalid CreateDataSource request shall yield an error output according to (OGC 05-008), section 8.

A CreateDataSource request is invalid in one of the following cases:

A mandatory request parameter is missing.
A request parameter value is not valid.
The data source does already exist.
The template does not exist.

1.2. RemoveDataSource Operation

The RemoveDataSource operation allows a client to completely remove a data source (schema and contents) from a geospatial database. Future extension: Available data sources are advertised in the service's GetCapabilities response.

1.2.1. RemoveDataSource Request

Request Parameter	Mandatory / Optional	Description
REQUEST=createDataSource	M	Request name.
NAME=aname	M	Datastore name.

Example request:

http://a.server.org/geodb-conf?
  request=RemoveDataSource
  &name=Baustellen

1.2.2. RemoveDataSource Response

The response to a valid RemoveDataSource request shall be a transaction report similar to the geodb-conf.CreateDataSource response.

An invalid RemoveDataSource request shall yield an error output according to (OGC 05-008), section 8.

A RemoveDataSource request is invalid in one of the following cases:

A mandatory request parameter is missing.
A request parameter value is not valid.
The data source to be removed is registered in a WFS instance.
The data source to be removed does not exist.

2. wfs-conf

The wfs-conf service allows a client to add or remove feature types in a deegree WFS instance.

2.1. AddFeatureType Operation

The AddFeatureType operation allows a client to register a new Feature Type in a WFS instance. Future extension: Available data sources are advertised in the service's GetCapabilities response.

2.1.1. AddFeatureType Request

Request Parameter	Mandatory / Optional	Description
REQUEST=AddFeatureType	M	Request name
NAME=aname	M	Feature type name.
TITLE=atitle	O	A human-readable string for presentation in a menu (default: empty string).
ABSTRACT=anabstract	O	Abstract is a narrative description of the feature type (default: empty string).
CRS=namespace:identifier	M	Coordinate reference system.
BBOX=minx,miny,maxx,maxy	M	Bounding box corners (lower left, upper right) in CRS units.
DATASTORE=adata sourceref	M	Datastore to be used for the feature type.

Example request:

http://a.server.org/wfs-conf?
  request=AddFeatureType
  &name=Baustellen
  &crs=EPSG:31466
  &bbox=2570850,5670700,2591781,5687791
  &data source=Baustellen

2.1.2. AddFeatureType Response

The response to a valid AddFeatureType request shall be a transaction report similar to the geodb-conf.CreateDataSource response.

An invalid AddFeatureType request shall yield an error output according to (OGC 05-008), section 8.

A AddFeatureType request is invalid in one of the following cases:

A mandatory request parameter is missing.
A request parameter value is not valid.
The feature type does already exist.
The data source does not exist.

2.2. RemoveFeatureType Operation

The RemoveFeatureType operation allows a client to remove an existing Feature Type from a WFS instance. Available Feature Types are advertised in the GetCapabilities response of the respective WFS service instance.

2.2.1. RemoveFeatureType Request

Request Parameter	Mandatory / Optional	Description
REQUEST=RemoveFeatureType	M	Request name.
NAME=aname	M	Feature type name.

Example request:

http://a.server.org/wfs-conf?
  request=RemoveFeatureType
  &name=Baustellen

2.2.2. RemoveFeatureType Response

The response to a valid RemoveFeatureType request shall be a transaction report similar to the geodb-conf.CreateDataSource response.

An invalid RemoveFeatureType request shall yield an error output according to (OGC 05-008), section 8.

A RemoveFeatureType request is invalid in one of the following cases:

A mandatory request parameter is missing.
A request parameter value is not valid.
The feature type to be removed is registered in a WMS instance.
The feature type to be removed does not exist.

3. wms-conf

The wms-conf service allows a client to add or remove layers and styles in a deegree WMS instance.

3.1. AddLayer Operation

The AddLayer operation allows a client to register a new Layer in a WMS instance. Available feature types are advertised in GetCapabilities response of the respective WFS service.

3.1.1. AddLayer Request

Request Parameter	Mandatory / Optional	Description
REQUEST=AddLayer	M	Request name.
NAME=aname	M	Layer name.
TITLE=atitle	M	A human-readable string for presentation in a menu.
ABSTRACT=anabstract	O	Abstract is a narrative description of the map layer (default: empty string).
PARENT=parentlayername	O	Name of the parent layer for the new layer (default: end of layer tree).
CRS=crslist	M	Coordinate reference system.
BBOX=minx,miny,maxx,maxy	M	Bounding box corners (lower left, upper right) in CRS units.
FEATURETYPES=featuretypelist	M	List of feature types to be used for the layer.
QUERYABLE=1\|0	O	Define if the layer is available for GetFeatureInfo (default: 0).
STYLES=stylelist	M	List of styles to be attached to the layer.

Example request:

http://a.server.org/wms-conf?
  request=AddLayer
  &name=Baustellen
  &title=Baustellenkartierung%20von%20Hr.%20Baumeister
  &crs=EPSG:4326,EPSG:31466,EPSG:31467
  &bbox=2570850,5670700,2591781,5687791
  &featuretypes=Baustelle

3.1.2. AddLayer Response

The response to a valid AddLayer request shall be a transaction report similar to the geodb-conf.CreateDataSource response.

An invalid AddLayer request shall yield an error output according to (OGC 05-008), section 8.

A AddLayer request is invalid in one of the following cases:

A mandatory request parameter is missing.
A request parameter value is not valid.
The layer name does already exist.
One of the feature types referenced is not available.

3.2. RemoveLayer Operation

The RemoveLayer operation allows a client to completely remove an existing Layer from a WMS instance.

3.2.1. RemoveLayer Request

Request Parameter	Mandatory / Optional	Description
REQUEST=RemoveLayer	M	Request name.
NAME=aname	M	Layer name.

Example request:

http://a.server.org/wms-conf?
  request=RemoveLayer
  &name=Baustellen

3.2.2. RemoveLayer Response

The response to a valid RemoveLayer request shall be a transaction report similar to the geodb-conf.CreateDataSource response.

An invalid RemoveLayer request shall yield an error output according to (OGC 05-008), section 8.

A RemoveLayer request is invalid in one of the following cases:

A mandatory request parameter is missing.
A request parameter value is not valid.
The layer to be removed does not exist.

3.3. AddStyle Operation

The AddStyle operation allows a client to register a new Style in a WMS instance.

3.3.1. AddStyle Request

Request Parameter	Mandatory / Optional	Description
REQUEST=AddStyle	M	Request name.
MODE=ReplaceAll	O	In ReplaceAll mode, all existing styles for a layer are logically deleted, and then the SLD-defined styles are inserted. (default: ReplaceAll). Future extensions include support for InsertAndReplace mode. $/!\$ replaceAll should better be called something else. This operation does not replace anything!
SLD=slddocumenturl	M	URL referencing SLD document.

Example request:

http://a.server.org/wms-conf?
  request=AddStyle
  &sld=http://my.ser.ver/mysld.xml

3.3.2. AddStyle Response

The response to a valid AddStyle request shall be a transaction report similar to the geodb-conf.CreateDataSource response.

An invalid AddStyle request shall yield an error output according to (OGC 05-008), section 8.

A AddStyle request is invalid in one of the following cases:

A mandatory request parameter is missing.
A request parameter value is not valid.
The style name does already exist.
The SLD document is invalid.

3.4. RemoveStyle Operation

The RemoveStyle operation allows a client to completely remove an existing style from a WMS instance.

3.4.1. RemoveStyle Request

Request Parameter	Mandatory / Optional	Description
REQUEST=RemoveStyle	M	Request name.
NAME=aname	M	Style name.

Example request:

http://a.server.org/wms-conf?
  request=RemoveStyle
  &name=Baustellen

3.4.2. RemoveStyle Response

The response to a valid RemoveStyle request shall be a transaction report similar to the geodb-conf.CreateDataSource response.

An invalid RemoveStyle request shall yield an error output according to (OGC 05-008), section 8.

A RemoveStyle request is invalid in one of the following cases:

A mandatory request parameter is missing.
A request parameter value is not valid.
The style to be removed does not exist

Service Specification

CategoryDeegree2