Sign in

v1

latestOpenAPI 3.1.22026-08-061127187.7 KB
Map

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

get/map/{district_id}

Path parameters

district_idnumber required

The id property from a District object.

Query parameters

format'json' | 'xml'

Specify the desired format of the response.

customer_idstring password required

Required. The License Key issued by Melissa.

keystring password

The License Key issued by Melissa.

widthnumber

The width in pixels of the returned map image.

heightnumber

The height in pixels of the returned map image.

fill_colorstring

The color of the district's shape.

fill_opacitystring

The opacity of the district's shape.

boundary_widthnumber

The width of the district's outline.

boundary_colornumber

The color of the district's outline.

boundary_line_joinstring

The type of line joins for the district's outline.

map_format'png' | 'png8' | 'png32' | 'png256' | 'jpeg'

The format of the map image.

srsstring

The EPSG code spatial reference system code for the map.

Headers

Accept'application/json' | '*/*' required

Format of the response.

Content-Type'application/json' | 'application/xml' required

Format of the request.

Response

Successful response