Class RouteSearch

Namespace

Geotab.Checkmate.ObjectModel

Assembly

Geotab.Checkmate.ObjectModel.dll

The object used to specify the arguments when searching for Route(s).

public class RouteSearch : Search, IEntity

Inheritance

object

Search

RouteSearch

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

RouteSearch()

Initializes a new instance of the RouteSearch class.

public RouteSearch()

RouteSearch(Id?)

Initializes a new instance of the RouteSearch class.

public RouteSearch(Id? id)

Parameters

id Id

Id

Properties

DeviceSearch

Gets or sets filter by the DeviceSearch options. Providing a device ID will search for any Routes that are assigned to that Device. Providing the Groups will search for Routes for that have Devices in that group. Available DeviceSearch options are: Only RouteType "Plan" have a Device assigned.

public DeviceSearch? DeviceSearch { get; set; }

Property Value

DeviceSearch

DeviceSearch

FromDate

Gets or sets search for Routes that were active at this date or after.

public DateTime? FromDate { get; set; }

Property Value

DateTime?

DateTime

Groups

Gets or sets search for ONLY Route Completion (RouteType.Service) routes that are members of these GroupSearch(s). Available GroupSearch options are:

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

Property Value

IList<GroupSearch>

Group search list.

IncludeRouteStatus

Gets or sets status for the routes. The default value is [false].

public bool? IncludeRouteStatus { get; set; }

Property Value

bool?

bool

MaxVersion

Gets or sets maximum version of the search criteria.

public long? MaxVersion { get; set; }

Property Value

long?

long

MinVersion

Gets or sets minimum version of the search criteria.

public long? MinVersion { get; set; }

Property Value

long?

long

Name

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

public string? Name { get; set; }

Property Value

string

string

RouteType

Gets or sets search for Routes with this RouteType.

public RouteType? RouteType { get; set; }

Property Value

RouteType?

RouteType

ServiceGroups

Gets or sets search for ONLY Route Completion (RouteType.Service) routes that are members of these GroupSearch(s) in the Service Group hierarchy. Available GroupSearch options are:

public IList<GroupSearch>? ServiceGroups { get; set; }

Property Value

IList<GroupSearch>

Group search list.

ToDate

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

public DateTime? ToDate { get; set; }

Property Value

DateTime?

DateTime

ZoneSearch

Gets or sets filter by the ZoneSearch options. Providing a zone ID will search for any Routes that contain that Zone. Providing Groups will search for Routes that have Zones in that group. Available ZoneSearch options are:

public ZoneSearch? ZoneSearch { get; set; }

Property Value

ZoneSearch

ZoneSearch