Class DeviceSearch

Namespace

Geotab.Checkmate.ObjectModel

Assembly

Geotab.Checkmate.ObjectModel.dll

The object used to specify the arguments when searching for a Device.

public class DeviceSearch : Search, IEntity

Inheritance

object

Search

DeviceSearch

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

DeviceSearch()

Initializes a new instance of the DeviceSearch class.

public DeviceSearch()

DeviceSearch(Id?)

Initializes a new instance of the DeviceSearch class.

public DeviceSearch(Id? id)

Parameters

id Id

the id to search by.

Properties

Comment

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

public string? Comment { get; set; }

Property Value

string

string

CustomPropertySearch

Gets or sets search for Devices that contain certain Property and/or PropertyValue<T> and/or belong to certain PropertySet.

public CustomPropertySearch? CustomPropertySearch { get; set; }

Property Value

CustomPropertySearch

CustomPropertySearch

DeviceCommunicationStatusSearch

Gets or sets search for devices that has DeviceCommunicationStatus and filter them by DeviceCommunicationStatusSearch Available DeviceCommunicationStatusSearch options are:

public DeviceCommunicationStatusSearch? DeviceCommunicationStatusSearch { get; set; }

Property Value

DeviceCommunicationStatusSearch

DeviceCommunicationStatusSearch

DeviceIds

Gets or sets search for Devices with these unique Id(s). Not Supported for searching for devices, only for DeviceStatusInfo, TachographDataFile, FaultData, and ChargeEvent.

public IEnumerable<Id>? DeviceIds { get; set; }

Property Value

IEnumerable<Id>

IEnumerable<T>

DevicePlan

Gets or sets search for devices that have the DevicePlan speicified

public DevicePlan? DevicePlan { get; set; }

Property Value

DevicePlan?

DevicePlan

DevicePlanBillingInfo

Gets or sets search for devices that have the DevicePlanBillingInfo speicified. Available DevicePlanBillingInfo options are:

public DevicePlanBillingInfo? DevicePlanBillingInfo { get; set; }

Property Value

DevicePlanBillingInfo

DevicePlanBillingInfo

DeviceReplacementInfoSearch

Gets or sets search for devices that contain DeviceReplacementInfo and filter them by DeviceReplacementInfoSearch Available DeviceReplacementInfoSearch options are:

public DeviceReplacementInfoSearch? DeviceReplacementInfoSearch { get; set; }

Property Value

DeviceReplacementInfoSearch

DeviceReplacementInfoSearch

Remarks

If IncludeDeviceReplacementInfo is false or null, the result will only filter by DeviceReplacementStatus but not return the DeviceReplacementInfo

DeviceType

Gets or sets search for Devices of this DeviceType.

public DeviceType? DeviceType { get; set; }

Property Value

DeviceType?

DeviceType

EngineVehicleIdentificationNumber

Gets or sets search for a Device by Vehicle Identification Number (VIN) reported by the engine. This is the unique number assigned to the vehicle during manufacturing and reported through any non-legacy GO device. This differs from VehicleIdentificationNumber in that it is the last VIN reported from the Device, and will be updated whether it is classified as valid or invalid.

public string? EngineVehicleIdentificationNumber { get; set; }

Property Value

string

string

ExcludeUntrackedAssets

Gets or sets filter for UntrackedAsset.

public bool? ExcludeUntrackedAssets { get; set; }

Property Value

bool?

true to exclude UntrackedAsset.

FromDate

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

public DateTime? FromDate { get; set; }

Property Value

DateTime?

DateTime

GroupFilterCondition

Gets or sets for devices and asset types.

public GroupFilterCondition? GroupFilterCondition { get; set; }

Property Value

GroupFilterCondition

And/or relation between groups to search

Groups

Gets or sets search for Devices that are a member of these GroupSearch(s). Each GroupSearch is an object within the array. Available GroupSearch options are:

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

Property Value

List<GroupSearch>

IList<T>

HardwareId

Gets or sets search for a Device with this unique hardware ID.

public int? HardwareId { get; set; }

Property Value

int?

int

IncludeDeviceReplacementInfo

Gets or sets search for devices that contain DeviceReplacementInfo and include this information to the result.

public bool? IncludeDeviceReplacementInfo { get; set; }

Property Value

bool?

true to include DeviceReplacementInfo.

IncludeProtobufCustomParameters

Gets or sets search for devices that contain ProtobufCustomParameter and include this information to the result.

public bool? IncludeProtobufCustomParameters { get; set; }

Property Value

bool?

true to include ProtobufCustomParameter.

IsCommunicating

Gets or sets filter for a device communication state.

public bool? IsCommunicating { get; set; }

Property Value

bool?

true to exclude assets that are not communicating.

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>.

LicensePlate

Gets or sets search for Devices with a license plate matching this value. Wildcard can be used by prepending/appending "%" to string. Example "%LicensePlate%".

public string? LicensePlate { get; set; }

Property Value

string

string

Name

Gets or sets search for Devices with this Name. Name is the primary description of the Device. Wildcard can be used by prepending/appending "%" to string. Example "%name%".

public string? Name { get; set; }

Property Value

string

string

SerialNumber

Gets or sets search for a Device by its unique serial number. Wildcard can be used by prepending/appending "%" to string. Example "%SerialNumber%".

public string? SerialNumber { get; set; }

Property Value

string

string

SerialNumbers

Gets or sets search for multiple Devices by their unique serial numbers. Not Supported for searching for devices, only for AddInDeviceLinkSearch

public IEnumerable<string>? SerialNumbers { get; set; }

Property Value

IEnumerable<string>

IEnumerable<T>

ToDate

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

public DateTime? ToDate { get; set; }

Property Value

DateTime?

DateTime

VehicleIdentificationNumber

Gets or sets search for a Device by Vehicle Identification Number (VIN). This is the unique number assigned to the vehicle during manufacturing. This differs from EngineVehicleIdentificationNumber in that it is the last VIN reported from the Device that was determined to be valid. Wildcard can be used by prepending/appending "%" to string. Example "%VehicleIdentificationNumber%".

public string? VehicleIdentificationNumber { get; set; }

Property Value

string

string