API Reference
Search documentation
karat

+

K

User Documentation ↗

Load Generic Symbol

GET/api/gotham/v1/maprendering/symbols/generic/{id}
Warning

This endpoint is in preview and may be modified or removed at any time. To use this endpoint, add preview=true to the request query parameters.

Loads a PNG format icon with the provided ID, resizing it if requested. This endpoint has the following features that make it more easily usable from browsers:

  • Respects the If-None-Match etag header, returning 304 if the icon is unchanged.
  • Will use a PALANTIR_TOKEN cookie if no authorization header was provided.
  • Returns Cache-Control and Content-Type headers.

Path parameters

id
string

The generic symbol ID returned by the service that uniquely identifies a symbol.

Query parameters

preview
boolean
optional

Represents a boolean value that restricts an endpoint to preview mode when set to true.

size
integer
optional

Resize the icon so that its reference size matches this value. The actually returned image may be larger or smaller than this value.

Response body

body
string

A successful render response.

Examples

Request

Copied!
1 2 3 curl \ \t-H "Authorization: Bearer $TOKEN" \ "https://$HOSTNAME/api/gotham/v1/maprendering/symbols/generic/ePkllYLiI7HHUFwC7Gyk5haAZvwB3ioZ3w?preview=true&size=15"