Geozone data type

Introduction

The geozone data type allows obtaining the configuration of a geozone. Below are all the properties of the geozone data type.

Properties

GeozoneID (int) The GeozoneID property represents the unique identifier of the geozone in the platform. This identifier is automatically assigned when a geozone is created. ### ClientID (int) Unique identifier of the client to which the geozone corresponds. ### Description (string) Indicates the description of the geozone. ### ExternalCode (string) Indicates an optional external code for the geozone. ### Polygon (object)

Contains the information of the polygon associated with the geozone. The polygon properties are:

• PolygonID (int): unique identifier of the polygon.
• Points (number[][]): array of coordinates, where each element of the array is a coordinate with its latitude and longitude.
• BorderColor (int): color used for the polygon border. Used when rendering the polygon on maps. Uses 24-bit RGB encoding.
• BorderWidth (int): width of the polygon border, in pixels.
• BorderOpacity (number): opacity of the polygon border, where 1 is completely opaque and 0 is completely transparent.
• FillColor (int): color used for the polygon fill. Used when rendering the polygon on maps. Uses 24-bit RGB encoding.
• FillOpacity (number): opacity of the polygon fill, where 1 is completely opaque and 0 is completely transparent.

Vehicles (object array)

Contains the information of vehicles currently located within the geozone. If no vehicle is within the geozone, the returned array will be empty. For each vehicle included in the array, the following data is provided:

• VehicleID (int): unique identifier of the vehicle.
• Description (string): description of the vehicle.
• LicensePlate (string): license plate number of the vehicle.

SequenceNumber (int64) Sequence number associated with the geozone. The sequence number is updated with a higher number each time the geozone configuration is modified, and when the geozone is deleted. Each created or modified geozone is guaranteed to receive a number higher than any other existing geozone. ### Enabled (bool) Indicates whether the geozone can be used, or if it has been deleted. The value false indicates that the geozone has been deleted. Deleted geozones can only be accessed through the API for getting a list of geozones incrementally.