Zones API Overview
The Altitude Zones API can be used to create, update, and read zone types and custom zones that can be used throughout the Altitude platform for various analyses.
This API uses the queryType parameter to retrieve data. Request information in the API call, such as Contained Zones or Custom Zone Types, and it returns that specific set of results. Each query type is a distinct request.
Basic Information
| serviceName | dna-altitude-zones |
| functionName | getData for queryTypes that are not marked with an asterisk. Otherwise, one of createQueryJob, cancelQueryJob, getJobStatus, or getQueryResults, as outlined in the Making an API Request guide. |
Error Codes
If the API fails, the possible responses for all queryTypes could be one of the following:
| HTTP Status Code | Response Type | Description |
|---|---|---|
| 400 | JSON | Occurs if your API request is a bad request e.g. invalid JSON, invalid queryType, invalid parameter type (e.g. string instead of integer), etc. |
| 401 | JSON | Occurs for various unauthorized tasks, such as not providing credentials in your parameters. |
| 403 | JSON | Occurs for various forbidden tasks, such as requesting data that you have not purchased. |
| 408 | JSON | Occurs if the API call exceeds 10 minutes and times out. |
| 429 | JSON | Occurs if you have exceeded your rate limit. |
| 500 | JSON | Occurs if an internal server error occurs. Contact altitudesupport@geotab.com if this occurs. |