queryType: getStandardZonesByHierarchy*

The getStandardZonesByHierarchy queryType is passed to the API to get a list of zones of the requested type, that are within the context of the input zone(s) (state, county, and city only) based on geography based hierarchies for the country.

Note:

See Special Case APIs for more information.

Parameters

These parameters should be passed to the functionParameters object regardless of which method you choose to make an API request.
ParameterDescriptionTypeDefined Value SetValue Req'd
queryTypeMust equal getStandardZonesByHierarchy.STRINGgetStandardZonesByHierarchyY
requestZoneTypeThe type of zones you want returned. STRINGZoneType - “State”, “County”, “City”, “TAZ”, “ZIP”, “CTR”, or “FSA”. Refer to Zones in the Data Dictionary for details on how to structure the zone inputs for each zone type. Y
zones

An array of objects representing the zones for which you want information. Each object contains ZoneId, ISO_3166_2, and ZoneType:

  • ZoneId (string)– A custom zone ID or a standard zone ID such as county ID, city ID, etc.

  • ISO_3166_2 (string)– The ISO code of the standard zone. Does not apply to custom zones and can be set to null.

  • ZoneType (string)– the type of zone.

ARRAYZoneType — “State”, “County”, “City”. Refer to Zones in the Data Dictionary for details on how to structure the zone inputs for each zone type. Y

Responses

CodeTypeDescription
200JSONThe requested data.
401JSONOccurs for various unauthorized tasks e.g. if you didn’t provide credentials in your parameters.
500JSONOccurs if an internal server error occurs. Contact altitudesupport@geotab.com if this occurs.

Response Schema

AttributeDescriptionData TypeDefined Value Set
GeographyA GeoJSON string representing the geography of the zone. STRING-
ISO_3166_2The ISO 3166:2 code for the state or province. STRING-
MaxLatitudeMaximum latitude of the zone. FLOAT64-
MaxLongitudeMaximum longitude of the zone. FLOAT64-
MinLatitudeMinimum latitude of the zone. FLOAT64-
MinLongitudeMinimum longitude of the zone. FLOAT64-
ZoneIdThe zone ID for which data is being returned. STRING-
ZoneDescription

Description of the zone when available. The value is based on the type of zone:

  • “State” — state name.

  • “County” — county name.

  • “City” — city name.

  • “CTR” — census tract description.

  • “Custom” — custom zone description, if available.

STRING-
ZoneTypeThe zone type of the zone. STRING“State”, ”County”, ”City”, ”CTR”, ”ZIP”, “TAZ”, “FSA”, “Custom” and “Segment”

Sample parameters

{
"zones": [{
	"ZoneId": "32003",
	"ISO_3166_2": "US-NV",
	"ZoneType": "county"
	}],
"queryType": "getStandardZonesByHierarchy",
"requestZoneType": "City"
}