Start zones by IDs job

Starts a job that will return GeoJSON features with zone metadata properties for each requested zone. Supply either an array of encoded zone ID strings (Base58) via zoneIds, or an array of zone objects via zones.

Altitude Help Center — getZonesData

Request Body

Zone selection and optional filters. Provide either zoneIds (encoded Base58 strings) or zones (objects with code, type, and iso_3166_2) — exactly one is required.

application/json: object

Name	Type	Input Shape	Values	Description	Value Required
`asOfDate`	string	-	-	Return zone data as of this date (YYYY-MM-DD). Omit for the most recent data.	N
`isMetric`	boolean	-	-	Override the requesting user's unit preference. Omit to use the user's stored preference.	N
`zoneIds`	array<string>	-	-	Encoded zone ID strings. Provide exactly one of zoneIds or zones (not both).	N
`zones`	array<object>	code: string; iso_3166_2: string; type: string	-	Zone objects with code, type, and iso_3166_2. Provide exactly one of zones or zoneIds (not both).	N

Examples

Clark County zone data (zone object)

Identify the zone by code, type, and ISO 3166-2 state code instead of an encoded ID.

{
  "zones": [
    {
      "code": "32003",
      "type": "County",
      "iso_3166_2": "US-NV"
    }
  ]
}

Clark County zone data (encoded ID)

The Base58 ID encodes US-NV_County_32003.

{
  "zoneIds": [
    "4YGGtN5UbfAywpxZwNLof3E42"
  ]
}

Success Responses

202 response: object

Job accepted and queued for processing. Poll the location header URL to check status.

Name	Type	Description
`error`	object	Details about why the job failed (RFC 7807 format), or null if it succeeded.
`id`	string	Unique job identifier.
`links`	object	Navigation URLs for polling and result retrieval.
`status`	string	Current job lifecycle state: PENDING, QUEUED, RUNNING, DONE, FAILED, CANCELED, or NOT_FOUND.

Response Errors

HTTP Status Code	Reason
400	The request body or parameters are invalid.
401	Authentication is required or the provided credentials are invalid.
403	The authenticated user lacks permission to perform this operation.
409	The operation conflicts with the current state of the resource.
422	The request is syntactically valid but semantically cannot be processed.
429	The request rate limit has been exceeded.
500	An unexpected server error occurred.