Collections: API: Request: Collection.getGeoLocations

This method returns the list of the distinct geographical locations associated with objects in the collection. Entries returned by this method will include a "code" property, which can be added to a collection.search call (as geo_location_code) to return the objects associated with the geolocation entry. (Note that only about 9% of the collection is associated with geographical locations.)

Arguments

specificity (Optional)

Optional parameter controlling the specificity of the results. For example, indicating a specificity of "city" will return the distinct cities in our collection. If specificity is "country", we'll return the distinct countries represented by our collection. If specificity is left blank, the complete list of distinct locations will be returned, which may include location entries as specific as a distinct locale/building (e.g. "Pennsylvania Station") within a city. (In SQL terms, think of "specificity" as a "GROUP BY" clause.) Enum. Valid values: city, country, continent.

start_index (Optional)

An integer indicating the first geolocation to return. If 0 is given, the first-ranked geolocation will be returned. If 10 is given, the response will contain geolocations 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 geolocations 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.

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, 768, 1536. Default 384.

format (Optional)

The response format. Valid values: xml, json, html, cdwalite, dublincore. 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.

Response

A successful invocation of Collection.getGeoLocations returns a RESPONSE envelope and a single GEOLOCATIONS element.

Example

Try changing the values below to modify the service URL. Click "Call" to see the result.