Start contained zones job

Creates a contained zones job. Finds all zones of a given type that are geographically contained within a set of parent zones.

Altitude Help Center — getContainedZones

Request Body

Contained zones query parameters.

application/json: object

Name	Type	Input Shape	Values	Description	Value Required
`asOfDate`	string	-	-	OSM basemap version date in YYYY-MM-DD format. Omit to use the most recent month.	N
`buffer`	number (double)	-	-	Buffer distance in metres applied around the parent zone boundary before finding contained zones. Omit to use no buffer.	N
`customZoneSubTypes`	array<string>	-	-	Custom zone sub-type IDs to filter results. An empty array includes all sub-types. Applies only when requestZoneTypes contains 'Custom'.	N
`excludeServiceRoads`	boolean	-	-	When true, service road categories are excluded. Applies only when requestZoneTypes contains 'Segment'.	N
`isMetric`	boolean	-	-	Override the requesting user's unit preference. Omit to use the user's stored preference.	N
`relatedRoadTypes`	array<RoadType>	-	living_street, motorway, motorway_link, primary, primary_link, residential, road, secondary, secondary_link, service, tertiary, tertiary_link, trunk, trunk_link, unclassified	Road types for related-road segments. Applies only when requestZoneTypes contains 'RelatedRoad'.	N
`requestZoneTypes`	array<ZoneType>	-	Country, State, County, City, FSA, ZIP, TAZ, CTR, Custom, Segment, RelatedRoad	Zone types of the contained zones to return. An empty array returns all zone types.	N
`roadTypes`	array<RoadType>	-	living_street, motorway, motorway_link, primary, primary_link, residential, road, secondary, secondary_link, service, tertiary, tertiary_link, trunk, trunk_link, unclassified	OSM road types to include when requestZoneTypes contains 'Segment'. An empty array includes all road types.	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

Contained zones request

Translated from the v1 getContainedZones sample.

{
  "isMetric": false,
  "requestZoneTypes": [
    "County"
  ],
  "zones": [
    {
      "code": "US-GA",
      "iso_3166_2": "US-GA",
      "type": "State"
    }
  ]
}

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.