Class TachographDataFileSearch

Namespace

Geotab.Checkmate.ObjectModel.Tachograph.Files

Assembly

Geotab.Checkmate.ObjectModel.dll

The object used to specify the arguments when searching for TachographDataFile.

public class TachographDataFileSearch : Search, IEntity

Inheritance

object

Search

TachographDataFileSearch

Implements

IEntity

Inherited Members

Search.Clone()

Search.GetReadOnly()

Search.Id

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Constructors

TachographDataFileSearch()

public TachographDataFileSearch()

Properties

ActivityTimestampBetween

Gets or sets the filter to search the files in a period of activity time. Available ActivityTimestampBetweenSearch options are:

public TachographDataFileSearch.ActivityTimestampBetweenSearch? ActivityTimestampBetween { get; set; }

Property Value

TachographDataFileSearch.ActivityTimestampBetweenSearch

TachographDataFileSearch.ActivityTimestampBetweenSearch

DeviceSearch

Gets or sets filter by the DeviceSearch options. Providing a device ID will search for any file that is assigned to that Device. Providing the Groups will search for files that have Devices in that group. Providing the device IDs will search for files that have Devices in that list.

Available DeviceSearch options are:

public DeviceSearch? DeviceSearch { get; set; }

Property Value

DeviceSearch

DeviceSearch

ErrorContains

Gets or sets search for contains text in errors.

public string? ErrorContains { get; set; }

Property Value

string

string

FromActivityTimestampEnd

Gets or sets datetime to filter by ActivityTimestampEnd. It will return the last file of each driver where ActivityTimestampEnd is greater than this value.

public DateTime? FromActivityTimestampEnd { get; set; }

Property Value

DateTime?

DateTime

FromFloorToCeilingTimestamp

Gets or sets the filter to search the files in a period of time from floor to ceiling. Available FloorToCeilingTimestampSearch options are:

public TachographDataFileSearch.FloorToCeilingTimestampSearch? FromFloorToCeilingTimestamp { get; set; }

Property Value

TachographDataFileSearch.FloorToCeilingTimestampSearch

TachographDataFileSearch.FloorToCeilingTimestampSearch

FromTimestamp

Gets or sets search for TachographFile records that were generated at this date or after.

public DateTime? FromTimestamp { get; set; }

Property Value

DateTime?

DateTime

FromUploadDate

Gets or sets search for file records that were uploaded at this date or after.

public DateTime? FromUploadDate { get; set; }

Property Value

DateTime?

DateTime

Ids

Gets or sets search for TachographFile Device Ids records are in the list.

public Id[]? Ids { get; set; }

Property Value

Id[]

Array

IncludeArchived

Gets or sets the flag to include archived files. By default archived tachograph data file records are not returned, set this flag to true to return all records.

public bool? IncludeArchived { get; set; }

Property Value

bool?

bool

IncludeBinaryData

Gets or sets the flag to include binary data in the response.

public bool? IncludeBinaryData { get; set; }

Property Value

bool?

bool

Keywords

Gets or sets search for entities that contain specific keywords into FileName, FileNameDdd, FileNameTgd, FileNameV1B, in case the “type = Driver” it will look into the driver's first name and last name, or when “type = Device” in the license plate.

Note: It is currently limited to only one keyword. To use keywords it is necessary to use the “type” filter too.

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

Property Value

IList<string>

IList<T>.

ProcessingStatus

Gets or sets search for files with a specific processing status.

public int? ProcessingStatus { get; set; }

Property Value

int?

int

ToTimestamp

Gets or sets search for TachographFile records that were generated at this date or before.

public DateTime? ToTimestamp { get; set; }

Property Value

DateTime?

DateTime

ToUploadDate

Gets or sets search for file records that were uploaded at this date or before.

public DateTime? ToUploadDate { get; set; }

Property Value

DateTime?

DateTime

Type

Gets or sets search for file records based on the file type. The available values are:

public string? Type { get; set; }

Property Value

string

string

UserSearch

Gets or sets filter by the UserSearch options. Providing a user ID will search for any file that is assigned to that user. Providing the Groups will search for files that have Users in that group. Providing the user IDs will search for files that have Users in that list, in this case the users will be drivers.

Available UserSearch options are:

public UserSearch? UserSearch { get; set; }

Property Value

UserSearch

UserSearch

Version

Gets or sets the row version of the TachographDataFile search criteria.

public override long? Version { get; set; }

Property Value

long?

long

WithoutError

Gets or sets search for files without errors.

public bool? WithoutError { get; set; }

Property Value

bool?

bool