Image and Metadata Addressing

The main server URL for image-, metadata- and list-requests will always be in the form http://your.fsi-server.com/fsi/server? followed by the desired parameter. If the application is deployed under a name different to "fsi" the above URL needs to be adapted accordingly.

The following sections describes the available parameters in detail and gives examples on their usage. Please note that not all parameter combinations are possible or make sense.

ASCII Code needs to be converted to UTF8.

Alternatively the FSI Server webinterface provides an easy way to try out the parameters and assemble image URLs more interactively. This interface is described in detail in section 3 of this manual. In addition to the following descriptions , "Server Addressing Quick Reference" contains a server addressing quick reference. The parameters described in this chapter apply to the default renderers. Other renderers might not support all the parameters listed here or rely on additional parameters. More on renderers can be found in the OpenAPI manual.

Source

The source parameter describes the accessed resource in form of a path. This can be either an image or a directory. The source parameter is mandatory.

Type

The mandatory type parameter defines the type of response expected. Available values are image, info and list. Image and info can be used if the source parameter defines an image file. Depending on the renderer used (see "Renderer") an image request will return a jpg, png or swf. Info and list requests provide access to image and directory meta data. The response type of these two depends on the used template (see "Template").

Width and Height

At least one of the parameters width or height must be provided for image requests. The value is interpreted as pixels and the result will be an image scaled to fit into the requested dimension. Depending on the renderer used the aspect ratio is preserved, so if width and height are specified the resulting image may be smaller than the requested size.

Rect

The optional rect parameter can be used in image requests. It allows cropping images prior to scaling. The value is expected to consist of four comma-separated float values. The first two values define the top-left corner and the other two values define the bottom-right corner of the crop area. All values are expected to be normalized, this means the valid values range from 0 to 1 where 0 is left or top and 1 is right or bottom.

Left, Top, Right, Bottom

The parameters left, top, right, bottom are a more human readable version of the rect parameter described above. The possible values are identical.

Quality

Used in image requests that return JPEG images this optional parameter defines the JPEG compression quality. The default value depends on the renderer settings.

Template

The template parameter defines the template used to render info and list responses. For more on templates see"Templates" in part I.

Effects

The effects parameter allows applying real-time image effects to an image. The effects parameter value is a comma-separated list containing the effect name followed by brackets containing effect-specific parameters. The effects will be applied in the order they are listed. For a detailed description of the available effects and the effects-specific parameters please see "Real-time Image Effects".

Renderer

Used in all request types this optional parameter defines the renderer used to build the response. If omitted the default renderer will be used. The default renderer is defined by the request processor settings. For more information on renderers see "Renderers" in part I.