DocumentationDynamic Media Image Serving and Rendering API

catalogprops catalogprops

Last update: Mon Jul 12 2021 00:00:00 GMT+0000 (Coordinated Universal Time)

CREATED FOR:

  • Developer
  • User

Image catalog properties. Returns common attributes of the image catalog specified in the request path.

req=catalogprops[,text|javascript|xml|{json[&id= *reqId*]}]

reqId
Unique request identifier.

To retrieve the default catalog properties ( default.ini), omit the catalog ID. The HTTP response is cacheable with the TTL based on attribute::NonImgExpiration.

Requests that support JSONP response format lets you specify the name of the JS callback handler using the extended syntax of req= parameter:

req=...,json [&handler = reqHandler ]

<reqHandler> is the name of the JS handler that is present in the JSONP response. Only a-z, A-Z, and 0-9 characters are allowed. Optional. Default is s7jsonResponse.

The following property values are returned:

Property
Type
Corresponding catalog attribute
catalog.bkgColor
hex
attribute::BkgColor
catalog::defaultExt
string
attribute::DefaultExt
catalog.defaultPix
int,int
attribute::DefaultPix
catalog.defaultThumbPix
int,int
attribute::DefaultThumbPix
catalog.expiration
real
attribute::Expiration
catalog.defaultExpiration
real
attribute::DefaultExpiration
catalog.nonImgExpiration
real
attribute::NonImgExpiration
catalog.fileTime
string
attribute::LastModified, or, if not present, the last modified time of the catalog .ini file
catalog.jpegQuality
int,bool
attribute::JpegQuality
catalog.maxPix
int,int
attribute::MaxPix
catalog.printResolution
int
attribute::PrintResolution
catalog.publishInfo
string
attribute::PublishInfo
catalog.resMode
enum
attribute::ResMode
catalog.resolution
real
attribute::Resolution
catalog.thumbBkgColor
hex
attribute::ThumbBkgColor
catalog.thumbHorizAlign
enum
attribute::ThumbHorizAlign
catalog.thumbRes
real
attribute::ThumbRes
catalog.thumbType
enum
attribute::ThumbType
catalog.thumbVertAlign
enum
attribute::ThumbVertAlign
catalog::watermark
string
attribute::Watermark
recommendation-more-help
a26166cd-f2f4-45ce-996d-96a0f0d6cf49