Collections: API: Request: Collection.getImages

This method returns images for the the specified item.

Arguments

item_type (Required)

Specify what type of record to return. Valid values: object, exhibition.

item_id (Required)

Provide the numeric id of the item to be retrived - as derived from a previous call to collection.search or another method. Integer.

start_index (Optional)

An integer indicating the first image to return. If 0 is given, the first-ranked images will be returned. If 10 is given, the response will contain images 10 through 10+results_limit. If start_index exceeds the number of images available no results will be returned. An integer greater than or equal to 0

results_limit (Optional)

An integer representing the maximum number of images to return. An integer between 1 and 20 inclusive. Default 10.

Inherited Arguments

api_key (Required)

Your personal API Key.

version (Required)

The API version you want to use. Integer. Valid values: 1.

format (Optional)

The response format. Valid values: xml, json, html. Default xml.

include_html_style_block (Optional)

Only applies to requests where format is html. Specifies whether or not to include a standard STYLE block with returned HTML content. The STYLE block dresses up the otherwise drab HTML. If you prefer to style the returned HTML yourself set this parameter to false. Boolean. Default True.

include_image_caption (Optional)

Specifies whether or not to include preformatted item captions in the response. Boolean.

include_item_fields (Optional)

Specifies whether or not to include lots of extra data about the item (e.g., medium, classification, credit, etc.). If you set this param to false note that you must display minimal fields when using Brooklyn Museum images. Boolean. Default True.

thumb_shape (Optional)

Specify "square" to retrieve thumbs that have been cropped to perfect squares Valid values: original, square. Default original.

max_thumb_size (Optional)

Specifies the maximum thumb size. (Size of longest dimension in pixels.) Note that the relevant values depend on the thumb_shape used. If you specify square thumbs your options are 50 and 150. Otherwise your options are 96 and 192. Valid values: 50, 96, 150, 192. Default 96.

max_image_size (Optional)

Specifies the maximum image size to return. Note that copyright restrictions sometimes prevent us from providing a large derivative. When that's the case, an image returned may be considerably smaller than the max you specify. Valid values: 384, 500. Default 384.

Response

A successful invocation of Collection.getImages returns a RESPONSE envelope and a single IMAGES element.

Example

Try changing the values below to modify the service URL. Click "Call" to see the result. See this example app for a full implementation of this method.

Errors

104: Invalid item_type

The item_type parameter was missing or invalid

105: Invalid item_id

The item_id parameter was missing or invalid

106: Item not found

The indicated item doesn't exist