You are here: Web API Functions > browse

browse

The browse command is used to retrieve information about the contents of an Express Server.

Syntax

The browse command may be invoked in several ways.

The following returns the catalogs published by the Express Server:

browse?

The following returns the contents of the specified catalog:

browse?cat=<catalog-name>

The following returns the contents of the specified folder within a catalog:

browse?cat=<catalog-name>&folder=<path>

The following returns detailed information about the specified item:

browse?cat=<catalog-name>&item=<itemid>

Parameters

The following parameters may be used with the browse command:

cat

The catalog name.

folder

The folder to browse.

item

The ID of the item to browse. The itemid is the folder path to the item plus the item name (or iserv-catalog-index, which specifies the spatial index).

props

List of item and catalog properties to display in the results. The syntax is

props=item(<prop>,<prop>,…),cat(<prop>,<prop>,…)

NOTE: It is possible to specify which item and catalog props are returned in catalogs.xml rather than specifying it in the URL for each query. See "Configuring the Catalog".

style

The XSL style sheet to be used when formatting the data for display. Refers to a directory or file in <Express Server installation directory>/ImageServer/docs/styles. If this value is missing, then the default stylesheet is assumed. An XML processing instruction will be inserted into the response which specifies the URL of the stylesheet to use when displaying this document. A special value of "none" specifies that no XSL stylesheet should be used.

Examples

The following examples are "live" in that they contain real URLs that will access an Express Server. Change the hostname to your host to see your own server's responses to these queries.

The following will return an XML document containing the list of catalogs on the server:

http://demo.lizardtech.com/lizardtech/iserv/browse?style=none

The following will return the same data, formatted with the "simple style." The style "simple" refers to the stylesheet located in <Express Server installation directory>/ImageServer/docs/styles/simple/default.xsl.

http://demo.lizardtech.com/lizardtech/iserv/browse?style=simple

The following will return the contents of the catalog "idaho", formatted in HTML using the default style sheet:

http://demo.lizardtech.com/lizardtech/iserv/browse?cat=idaho