Class TripSearch

Namespace

Geotab.Checkmate.ObjectModel

Assembly

Geotab.Checkmate.ObjectModel.dll

search

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

This search has been designed to work efficiently with these combinations of parameters:

public class TripSearch : Search, IEntity

Inheritance

object

Search

TripSearch

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

TripSearch()

Initializes a new instance of the TripSearch class.Constructor.

public TripSearch()

TripSearch(Id?)

Initializes a new instance of the TripSearch class.Constructor.

public TripSearch(Id? id)

Parameters

id Id

The identifier.

Properties

DeviceSearch

Gets or sets search for Trips with this DeviceSearch Id. Available DeviceSearch options are:.

public DeviceSearch? DeviceSearch { get; set; }

Property Value

DeviceSearch

DeviceSearch

FromDate

Gets or sets search for Trips recorded at this date or after. When "IncludeOverlappedTrips" is set to True, search for Trips where the NextTripStartTime is at this date, after or NULL.

public DateTime? FromDate { get; set; }

Property Value

DateTime?

DateTime

IncludeDeleted

Gets or sets a value indicating whether trip search allows including deleted records

public bool IncludeDeleted { get; set; }

Property Value

bool

bool

IncludeOverlappedTrips

Gets or sets a value indicating whether when OverlappedTrips is set to True; any part of a trip that overlaps with the FromDate or ToDate boundary will have the entire trip included in the data.

public bool? IncludeOverlappedTrips { get; set; }

Property Value

bool?

bool

MaxId

Gets or sets maximum Id of the search criteria.

public Id? MaxId { get; set; }

Property Value

Id

Id

MinId

Gets or sets minimum Id of the search criteria.

public Id? MinId { get; set; }

Property Value

Id

Id

SearchArea

Gets or sets search rectangular area for Trips; the trips being retrieved must be located in this area. The BoundingBox object should contain the bottom left and top right coordinates of the searching rectangle.

public BoundingBox? SearchArea { get; set; }

Property Value

BoundingBox

BoundingBox

ToDate

Gets or sets search for Trips recorded at this date or before. When "IncludeOverlappedTrips" is set to True, search for Trips where the StartDateTime is this date or before.

public DateTime? ToDate { get; set; }

Property Value

DateTime?

DateTime

UserSearch

Gets or sets search for Trips with this UserSearch Id. Available UserSearch options are:.

public UserSearch? UserSearch { get; set; }

Property Value

UserSearch

UserSearch