queryType: getCustomZoneTypes
The getCustomZoneTypes queryType is passed to the API to get the list of zone types that you have already created via the createZoneType queryType above.
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 getCustomZoneTypes. | STRING | getCustomZoneTypes | Y |
| customZoneTypeStatuses | Optional array of zone type status IDs, where 0 = deleted and 1 = active. If you want all active zone types only, for example, pass [1]. Pass an empty array to get all zone types. | ARRAY | [0,1] | N |
Responses
| Code | Type | Description |
|---|---|---|
| 200 | JSON | The requested data. |
| 401 | JSON | Occurs for various unauthorized tasks e.g. if you didn’t provide credentials in your parameters. |
| 500 | JSON | Occurs if an internal server error occurs. Contact altitudesupport@geotab.com if this occurs. |
Response Schema
| Attribute | Description | Data Type | Defined Value Set |
|---|---|---|---|
| Comments | The comments related to the zone type. | STRING | - |
| CreatedBy | The user ID of the person who originally created the zone type. | STRING | - |
| CreatedTimestamp | The date and time the zone type was created wrapped inside an object with a value attribute. | OBJECT | - |
| CustomZoneTypeId | The unique ID of the zone type. | STRING | - |
| CustomZoneTypeDescription | The name of the zone type. | STRING | - |
| CustomZoneTypeStatus | The status of the custom zone type. 0 for “Deleted” and 1 for “Active” | STRING | 0 for “Deleted” and 1 for “Active” |
| Database | The database in which the zone type was created. | STRING | - |
| ModifiedBy | The user ID of the person who last modified the zone type. | STRING | - |
| ModifiedByTimestamp | The date and time the zone type was last modified wrapped inside an object with a value attribute. | OBJECT | - |
Sample parameters
{
"customZoneTypeStatuses":[1],
"queryType":"getCustomZoneTypes"
}
