queryType: createCustomZoneType
The createCustomZoneType query type is passed to the API to create a custom zone type, which can later be used to group similar custom zones together.
Each custom zone must have a custom zone type associated with it to be visible on the front end, so custom zone types must be created first.
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 createCustomZoneType. | STRING | createCustomZoneType | Y |
| comments | Optional comments to describe the zone type. | STRING | - | N |
| customZoneTypeName |
The name of the custom zone type (e.g. "Rest stops.")
Note: The zone type name must be unique within a database. | STRING | - | Y |
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 | |
CustomZoneTypeName | 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
{
"customZoneTypeName": "new custom zone type name",
"comments": "new custom zone type comment",
"queryType":"createCustomZoneType"
}