Changing Responses with Representation Modifiers

Places (Search) API media types allow you to specify some aspects of how the information contained in a response is presented. You can change the following aspects of information contained in a response:

Use the appropriate query parameters as indicated below to set the representation modifiers in your request.

Refer to the sections on the individual media types for details on which representation modifiers are supported for each type.

The size parameter defines the maximum number of items that should be in a page in responses that contain paginateble collections. If you do not specify a value for size, each collection may define its own default. Individual collections may define a maximum page size and then use that instead of the value provided in the search results.

Some response attributes are defined as rich text strings. You can use the text format parameter (tf) to specify the format of rich text attributes.

When a resource provides a URI for image resources (for example, photos of a place), you can specify maximum sizes for those images in your request to match your UI and bandwidth requirements.

The format is a comma-separated list, where each element specifies dimensions for a scaled image by providing the desired width, the desired height, or both.

The provided values are used as upper limits for the dimensions of the images in the responses. Small images are never scaled and the aspect ratio of the original image remains intact.

If you use the parameter image_dimensions, the image objects in media.images.items contain a dimensions attribute, which is a map containing links to the sized variants of the original image.

{
  "src": "http://...",
  "dimensions": {
    "w32-h32": "http://...",
    "w64-h64": "http://..."
  }
}

The parameter show_content allows you to request additional content related to the search result.

The format is a comma-separated list of content names.

"fuelPrices": {
  "text":"Super Unleaded: EUR 1.359/l<br/>Diesel: EUR 1.089/l",
  "label":"Fuel Prices"
}

The parameter show_refs allows you to request that place/location IDs from external systems be included in the response.

The format is a comma-separated list of external system names.

For more detailed information, see External References.

You can use the parameter teasers to specify the maximum number of places in a response to a search request that should have teaser information (for example, an image URL) included.

The format is a numeric value, with the default 0.

The parameter cs allows you to request that multiple POI categories from different category systems be included in the response.

The format is a comma-separated list of category system names.