Class ZoneSearch

Namespace

Geotab.Checkmate.ObjectModel

Assembly

Geotab.Checkmate.ObjectModel.dll

true search The object used to specify the arguments when searching for Zone(s).

public class ZoneSearch : Search, IEntity

Inheritance

object

Search

ZoneSearch

Implements

IEntity

Inherited Members

Search.Clone()

Search.GetReadOnly()

Search.Id

Search.Version

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Constructors

ZoneSearch()

Initializes a new instance of the ZoneSearch class.Constructor.

public ZoneSearch()

ZoneSearch(Id?)

Initializes a new instance of the ZoneSearch class.Constructor.

public ZoneSearch(Id? id)

Parameters

id Id

The Id.

Properties

ExternalReference

Gets or sets search for Zones with this External Reference. Wildcard can be used by prepending/appending "%" to string. Example "%reference%".

public string? ExternalReference { get; set; }

Property Value

string

Reference.

FromDate

Gets or sets search for Zones that were active at this date or after. Set to UTC now to search for only currently active (non-archived) zones.

public DateTime? FromDate { get; set; }

Property Value

DateTime?

DateTime

GeometryType

Gets or sets search for Zones that have geometry type of GeometryTypeSearch.

public GeometryTypeSearch? GeometryType { get; set; }

Property Value

GeometryTypeSearch?

GeometryTypeSearch

GroupFilterCondition

Gets or sets the zones that belong to groups that are combined with the and/or relation.

public GroupFilterCondition? GroupFilterCondition { get; set; }

Property Value

GroupFilterCondition

And/or relation between groups to search

Groups

Gets or sets search for Zones that are members of these GroupSearch(s) one of it's children or one of it's parents. Available GroupSearch options are:

public List<GroupSearch>? Groups { get; set; }

Property Value

List<GroupSearch>

Group search list.

IncludeGroups

Gets or sets include zones that are in the in this hierarchy of the GroupSearch(s) provided. If no GroupSearch(s) are provided the user's data scope groups will be used. Default: IncludeGroups.ParentAndChild.

public IncludeGroups? IncludeGroups { get; set; }

Property Value

IncludeGroups?

Included groups.

IncludeMetadata

Gets or sets search for zones including metadata or not

public bool? IncludeMetadata { get; set; }

Property Value

bool?

bool

Keywords

Gets or sets search for entities that contain specific keywords in all wildcard string-searchable fields.

public IList<string>? Keywords { get; set; }

Property Value

IList<string>

IList<T>.

MinimumRadiusInMeters

Gets or sets exclude Zones whose radius is smaller than this size (meters).

public int? MinimumRadiusInMeters { get; set; }

Property Value

int?

Nullable<T> where T is int Radius in meters.

Name

Gets or sets search for Zones with this Name. Wildcard can be used by prepending/appending "%" to string. Example "%name%".

public string? Name { get; set; }

Property Value

string

The name.

SearchArea

Gets or sets the BoundingBox search for Zones in this area extent, the zones being retrieved must be located in this area. Typically used for retrieving Zones in the extents of a bounding box. The SearchArea object should contain the minimum and maximum latitude and longitude representing the search area.

public BoundingBox? SearchArea { get; set; }

Property Value

BoundingBox

An areas extent.

ToDate

Gets or sets search for Zones that were active at this date or before.

public DateTime? ToDate { get; set; }

Property Value

DateTime?

DateTime

ZoneTypes

Gets or sets search for Zones that are of type ZoneTypeSearch(s). Available ZoneTypeSearch options are:

public List<ZoneTypeSearch>? ZoneTypes { get; set; }

Property Value

List<ZoneTypeSearch>

ZoneType search list.