map

Turn the Map API off

Free. The map routes stop at once. The month stays a minimum month and a minimum already paid is not refunded. Turning it on again in the same month charges nothing more. Takes a secret API key or an admin session; a map browser key is not accepted here.

post/v1/map/disable

Request

  • Base URL: https://api.offendersearch.app
  • URL: https://api.offendersearch.app/v1/map/disable
  • Auth: one of:
    • API key in header X-API-Key
    • HTTP bearer

Response

The plan after the call.

enabledboolean

The Map API is on.

pausedboolean
sandboxboolean

The plan answers in test mode.

everEnabledboolean
enabledAtstring date-time nullable
disabledAtstring date-time nullable
pinMinZoominteger

Pins start at this zoom.

nameMinZoominteger

Names start at this zoom.

maxMarkersinteger

Most pins in one response.

maxTilesPerRequestinteger

Most tiles one view may cover at its zoom.

markerIdTtlSecondsinteger

How long marker and group ids work.

markerFields'basic' | 'named'

basic labels read J. Smith; named labels read John Smith.

minimumUsdnumber

The monthly minimum, in dollars.

minimumWaivedUntilstring date nullable
minimumAppliesThisMonthboolean
minimumPaidThisMonthUsdnumber

What was charged toward this month's minimum when the Map API was turned on.

termsstring[]

The rates and the minimum, in sentences.

changedboolean

false when the Map API was already off.

Example response

{
  "pinMinZoom": 13,
  "nameMinZoom": 15,
  "maxMarkers": 300,
  "maxTilesPerRequest": 64,
  "markerIdTtlSeconds": 86400,
  "rates": {
    "requestUsdPer1k": 2,
    "recordOpenUsd": 0.015
  },
  "minimumUsd": 300,
  "sweep": {
    "tilesPerDay": 20000,
    "endUserTilesPerDay": 2000
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.