queryType: getGeography*
The getGeography queryType is passed to the API to get all the geography for output zones of an analysis.
Note:
See Special Case APIs for more information.
Geography is available for all analyses that return results by zone (including segments).
Parameters
These parameters should be passed to the functionParameters object regardless of which method you choose to make an API request.
| Parameter | Description | Type | Defined Value Set | Value Req'd |
|---|---|---|---|---|
| queryType | Must equal getGeography. | STRING | getGeography | Y |
| analysisJobId | The job id that was used to generate the analysis. | STRING | - | Y |
Responses
| Code | Type | Description |
|---|---|---|
| 200 | JSON | The requested data. |
| 401 | JSON | Occurs for various unauthorized tasks, such as not providing credentials in your parameters. |
| 500 | JSON | Occurs if an internal server error occurs. Contact altitudesupport@geotab.com if this occurs. |
Response Schema
The response schema for this API is dependent on what the queryType is of the analysis you are retrieving and the identifiers for the zones being analyzed.
Sample parameters
{
"analysisJobId": "<analysisJobId>",
"queryType":"getGeography"
}