Managing Zones

The Zone Management page allows you to view and edit your Zones.

To manage or edit your Zones, navigate to the Custom Zones page by selecting Custom Zones from the main menu or the Welcome to Altitude! page.

The Zone Management page includes the following:

  • Zones table

  • Map

You can do the following on the Zone Management page:

  • Click the arrows to collapse the table or the map.

  • Zoom in the map to more intricately view your zones.

  • Select a zone from the table to view it on the map.

  • Enter a zone name on the search bar to look for specific zones.

Creating Zones

Learn how to create zones on a map, including selecting the location, defining boundaries, and specifying zone details.

To create Zones:
  1. Click + Add Zone from the Custom Zones page, then select Create on Map.
  2. Zoom the map to the location where you want to create your zone, or type a location on the Find an address or place field on the map. To view your dataset boundaries, enable the Dataset icon toggle.
  3. Select a starting point on the map to define the boundary of the zone by clicking the correct location.
  4. Select additional points along the perimeter to create the boundary. A line connects the points showing the perimeter in the order you add them.
  5. To finish, re-select the first point to close the zone. Once you close the Zone, the Create New Zone panel is displayed.
  6. Enter a Zone name and Zone type on the Create New Zone panel. On the Zone type field, select an existing type or click Add Zone Type to add a new one. When adding a new type, enter a name and select the check icon to add it.
  7. You can now select the new type from the list. You can add multiple zones types for the same zone. To remove a zone type from the zone you are creating, click the x next to its name. Click Create Zone.

Zones parameters

The zones input parameter allows users to input all categories of Altitude zones using a single construct.

The zones parameters is an array of objects (allows for multiple zones to be input at once), where each object defines a zone using the following attributes:

ZoneId (string)
A unique identifier for the zone.
ISO_3166_2 (string)
ISO 3166:2 code of the country and state or province in which the zone resides. This attribute does not apply to custom zones, segments or related roads and can be set to null.
ZoneType (string)
The type of zone. The value set for this attribute is: "State", "County", "City", "ZIP", "FSA", "TAZ", "CTR", "Segment", "Custom".

JSON examples

This section provides an example of how to structure the JSON for each zone type.

Note:

The input values for the Zones input parameter for different zone types can be obtained using the getContainedZones API.

State

A state or province geography.

JSON example
"zones":[
    {
    "ZoneId":"32", 
    "ISO_3166_2":"US-NV", 
    "ZoneType":"State"
    },
    {
    "ZoneId":"US-CA", 
    "ISO_3166_2":"US-CA", 
    "ZoneType":"State"
    }
]
Object attribute values
Attribute nameValueRequirement
ZoneIdProvide either the 2 digit FIPS code for the state, e.g. “06” for California, USA; or the state ISO 3166:2 code for the country and state, e.g. “US-CA” for California, USA.Required
ISO_3166_2The ISO 3166:2 value for the country and state.Required
ZoneTypeThe fixed string value: "State".Required
County

USA counties and Canadian census subdivisions.

JSON example
"zones":[
    {
    "ZoneId":"32003", 
    "ISO_3166_2":"US-NV", 
    "ZoneType":"County"
    },
    {
    "ZoneId":"2403005", 
    "ISO_3166_2":"CA-QC", 
    "ZoneType":"County"
    }
]
Object attribute values
Attribute nameValueRequirement
ZoneId

For USA counties this is a 5-character string where the first 2 characters are the state FIPS code (0 left padded) and the last 3 characters are the county FIPS code (0 left padded), e.g. “32003”.

For Canadian census subdivisions this is a 7-character string where the first 2 characters are the province identifier (0 left padded) and the last 5 characters are the census subdivision identifier (0 left padded), e.g. “2403005”.

Required
ISO_3166_2The ISO 3166:2 value for the country and province.Required
ZoneTypeThe fixed string value: "County".Required
City

USA cities only.

JSON example
"zones":[
    {
    "ZoneId":"3240000", 
    "ISO_3166_2":"US-NV", 
    "ZoneType":"City"
    }
]
Object attribute values
Attribute nameValueRequirement
ZoneId7-character string where the first 2 characters are the state FIPS code (0 left padded) and the last 5 characters are the city identifier (0 left padded), e.g. “3240000”Required
ISO_3166_2The ISO 3166-2 value for the country and state in which the city predominantly resides.Required
ZoneTypeThe fixed string value: "City".Required
Zip Code (ZIP)

USA zip codes only.

JSON example
"zones":[
    {
    "ZoneId":"89406", 
    "ISO_3166_2":"US-NV", 
    "ZoneType":"ZIP"
    }
]
Object attribute values
Attribute nameValueRequirement
ZoneId5-character string for the zip code (0 left padded), e.g. “ 89406”.Required
ISO_3166_2The ISO 3166:2 value for the country and state in which the zip code predominantly resides.Required
ZoneTypeThe fixed string value: "ZIP".Required
Forward Sortation Areas (FSA)

Forward Sortation Areas (FSA) for Canadian postal codes.

JSON example
"zones":[
    {
    "ZoneId":"G4T", 
    "ISO_3166_2":"CA-QC", 
    "ZoneType":"FSA"
    }
]
Object attribute values
Attribute nameValueRequirement
ZoneIdCFSAUID 3-character code which uniquely identifies forward sortation areas, e.g. “ G4T”.Required
ISO_3166_2The ISO 3166:2 value for the country and province in which the FSA resides Required
ZoneTypeThe fixed string value: "FSA".Required
Traffic Analysis Zones (TAZ)

USA traffic analysis zones (TAZ) only.

JSON example
"zones":[
    {
    "ZoneId":"3200300000707", 
    "ISO_3166_2":"US-NV", 
    "ZoneType":"TAZ"
    }
]
Object attribute values
Attribute nameValueRequirement
ZoneIdGEOID10, which is 13-character code where the first 2 characters are the state FIPS code (0 left padded), the next 3 characters are the county FIPS code (0 left padded) and the last 8 characters are the traffic analysis zone code (0 left padded), e.g. “3200300000707”.Required
ISO_3166_2The ISO 3166:2 value for the country and province in which the TAZ resides.Required
ZoneTypeThe fixed string value: "TAZ".Required
Census Tract 2020 (CTR)

USA census tracts (CTR) only.

JSON example
"zones":[
    {
    "ZoneId":"32001950100", 
    "ISO_3166_2":"US-NV", 
    "ZoneType":"CTR"
    }
]
Object attribute values
Attribute nameValueRequirement
ZoneId11-character code where the first 2 characters are the state FIPS code (0 left padded), the next 3 characters are the county FIPS code (0 left padded) and the last 6 characters are the census tract code (0 left padded), e.g. “32001950100”.Required
ISO_3166_2The ISO 3166:2 value for the country and province in which the CTR resides.Required
ZoneTypeThe fixed string value: "CTR".Required
Custom Zone

Geotab Altitude created custom zones.

JSON example
"zones":[
    {
    "ZoneId":"z-qu7zzmo9pgd", 
    "ISO_3166_2":null, 
    "ZoneType":"Custom"
    }
]
Object attribute values
Attribute nameValueRequirement
ZoneIdAltitude generated zone id in the format “z-<>”.Required
ISO_3166_2This attribute is not utilized for custom zones; pass a null equivalent.Not Required
ZoneTypeThe fixed string value: "Custom".Required
Segment

Geotab Altitude basemap segments.

JSON example
"zones":[
    {
    "ZoneId":"-2088543117912970036", 
    "ISO_3166_2":null, 
    "ZoneType":"Segment"
    }
]
Object attribute values
Attribute nameValueRequirement
ZoneIdGeotab Altitude unique identifier for a road segment.Required
ISO_3166_2This attribute is not utilized for segments; pass a null value equivalent.Not Required
ZoneTypeThe fixed string value: "Custom".Required

Importing Zones

Learn how to import zones from GeoJSON or Shapefile.

To import Zones:
  1. From the Custom Zones page, click + Add zone and select Upload from GeoJSON or Shapefile.
  2. Review the Guidelines for Upload. If you are unsure how to arrange your file before uploading, click Download sample template and select the template for your preferred format: Sample Shapefile (.zip) or Sample GeoJSON.
  3. Upload your Shapefile or GeoJSON file, and a prompt to map your data columns to the relevant fields in Altitude displays.
  4. In the preview section, see the number of valid and invalid zones in your file. Click the arrows on each banner to review which zones are valid and invalid. Only valid zones will be imported. You can fix your file and upload it again to correct the invalid zones.
  5. Select a zone type for the valid zones. Click Import Valid Zones.

Editing Zones

There are three ways to edit Zones: you can edit multiple Zones, edit from the Zones table, and edit from the map.

Editing multiple Zones

You can edit more than one zone at the same time. Instead of changing their name, type, and comments, you will be able to edit their zone type only.
  1. Select the zones you want to edit by selecting the checkbox in front of their names on the table, or clicking them on the map.
  2. Click the Edit button on the toolbar.
  3. Select the zone types you want to add or remove for all the selected zones, then click Save.

Editing Zones from the table

You can edit the zone name, zone type or comment fields from the Custom Zones page.

You can edit a Zone from the zones table or from the map. To edit a zone from the table:

  1. Find the zone you want to edit on the table and click the pencil icon located on the Action column.
  2. Edit the zone name, zone type or comment fields, then click Save.

Editing Zones from the map

You can edit the zone name, zone type or comment fields from the map on the Custom Zones page.

You can edit a Zone from the zones table or from the map. To edit a zone from the map:
  1. Zoom in the map to the location of the zone you want to edit, or type a location on the Search zones field.
  2. Hover over the desired zone and right click to display the Edit zone option.
  3. Edit the zone name, zone type or comment fields, then click Save.

Deleting Zones

You can delete a single Zone or multiple Zones from the Custom Zones table.

Deleting a single Zone

Delete a single Zone form the Custom Zones table.

To delete a Zone:

  1. From the Custom Zones page, find the zone you want to delete on the table and click the three dots located on the Action column.
  2. Click Remove.
  3. On the Remove Zones popup box, click Yes, remove.

Deleting multiple Zones

Delete multiple Zones form the Custom Zones table.

To delete multiple Zones:
  1. From the Custom Zones page, select the zones you want to delete by selecting the checkbox in front of their names on the table, or clicking them on the map.
  2. Click the Remove button on the toolbar.
  3. On the Remove Zones popup box, click Yes, remove.

Editing or removing zone types

Remove or rename zone types from the Custom Zones page.

To edit or remove a zone type:
  1. From the Custom Zones page, select any zone and click the pencil icon located on the Action column.
  2. Open the Zone type dropdown list.
  3. Click the three dots next to the zone type you want to edit or remove.
  4. Select Rename to update the zone type name, Get Info to review the zone type information, or Remove to delete the zone type.
    Note:

    Before deleting a zone type, you must assign a new zone type to any zone that has that zone type as their only assigned type. Removing a zone type will not remove zones associated with that zone type.

Custom Zones table filters

Find information on the Custom Zones table by using the search box or zone type filter.

The following searching and filtering options are available on the Custom Zones table:

Search zones
Enter a specific zone name you are interested in.
Zone type filter
Choose the zone types you want to filter by selecting the appropriate checkboxes, and select the modifier All (to view all zones belonging to all the selected zone types at the same time) or Any (to view all zones belonging to any of the selected zone types). After selecting the zone types to filter, click Apply to view information about them in the table.

To clear filters, click the X next to each zone type name or click Clear on the Zone Type Filter dropdown.

Managing zone types

The Custom Zones page allows you to view and edit zone types.

To view and manage your zone types:
  1. Navigate to Custom Zones from the main menu and click Manage zone types.
  2. From the Zone Types page, click the icons under the Action column to edit (pencil) or remove (trash can) a zone type. Removing a zone type will not remove any zones in that zone type.
  3. Optional: When editing a zone type, you can update the Zone type name and Comments related to that zone type. Click Save when you are done.