# Get map image

Cicero makes simple maps of district boundaries available through the map resource.

Use the id property from a District object with this resource to request an image showing the shape of the district. The appearance of the map can be configured beyond the default style with graphical parameters.

JSON and XML responses will contain the image as a data URI. Requests with format=image will return only the image.

Cost: 1 credit

Endpoint: GET /map/{district_id}

## Query parameters:

  - `format` (string)
    Specify the desired format of the response.
    Enum: "json", "xml"

  - `customer_id` (string, required)
    The License Key issued by Melissa.
    Example: "{REPLACE-WITH-YOUR-LICENSE-KEY}"

  - `width` (number)
    The width in pixels of the returned map image.

  - `height` (number)
    The height in pixels of the returned map image.

  - `fill_color` (string)
    The color of the district's shape.

  - `fill_opacity` (string)
    The opacity of the district's shape.

  - `boundary_width` (number)
    The width of the district's outline.

  - `boundary_color` (number)
    The color of the district's outline.

  - `boundary_line_join` (string)
    The type of line joins for the district's outline.

  - `map_format` (string)
    The format of the map image.
    Enum: "png", "png8", "png32", "png256", "jpeg"

  - `srs` (string)
    The EPSG code spatial reference system code for the map.

  - `key` (string)
    The License Key issued by Melissa.

## Path parameters:

  - `district_id` (number, required)
    The id property from a District object.

## Response 200 fields (application/json):

  - `response` (object)

  - `response.errors` (array)
    If the request encountered an error or errors, details about the error(s) will be contained in this field.

  - `response.messages` (array)
    Contains the resources matching the request query, if any.

  - `response.results` (object)
    Contains additional information about the outcome of a request that is not an error and not part of a query result.

  - `response.results.maps` (array)

  - `response.results.maps.extent` (object)

  - `response.results.maps.extent.x_min` (number)

  - `response.results.maps.extent.x_max` (number)

  - `response.results.maps.extent.y_min` (number)

  - `response.results.maps.extent.y_max` (number)

  - `response.results.maps.extent.srid` (number)

  - `response.results.maps.img_src` (string)

## Response 400 fields (application/json):

  - `response` (object)

  - `response.errors` (array)
    If the request encountered an error or errors, details about the error(s) will be contained in this field.
    Example: ["A detailed message about the error."]

  - `response.messages` (array)
    Contains the resources matching the request query, if any.

  - `response.results` (object)
    Contains additional information about the outcome of a request that is not an error and not part of a query result.