queryType: updateCustomZoneType
The updateCustomZoneType queryType is passed to the API to update a custom zone type already created via the queryType: createCustomZoneType.
Parameters
These parameters should be passed to the functionParameters object regardless of which method you choose from here.
| Parameter | Description | Type | Defined Value Set | Value Req'd |
|---|---|---|---|---|
| queryType | Must equal updateCustomZoneType. | STRING | updateCustomZoneType | Y |
| comments | Comments you want to add to the zone type. Not required, but if you do not pass a value, the comments will be updated with the provided value. | STRING | - | N |
| customZoneTypeId | The ID of the zone type you wish to modify. | STRING | - | Y |
| customZoneTypeName | The name of the zone type. Not required, but If you pass a value, the existing custom zone type name will be overwritten with this name. Note: The zone type name is required to be unique within a database. | STRING | - | N |
| customZoneTypeStatus | The status of the zone type. Pass 0 to set it to “Deleted” and 1 to set it to “Active”. Not required, but if you do pass a value, the status will be updated with the provided value. | INTEGER | [0,1] | N |
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
| 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 |
There is no response for this API, just an empty array.
Sample parameters
{
"customZoneTypeId":"zt-<>",
"customZoneTypeName":"updated custom zone type name",
"queryType":"updateCustomZoneType"
}