Class UserSearch

Namespace

Geotab.Checkmate.ObjectModel

Assembly

Geotab.Checkmate.ObjectModel.dll

The object used to specify the arguments when searching for a User/Driver.

public class UserSearch : Search, IEntity

Inheritance

object

Search

UserSearch

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

UserSearch()

Initializes a new instance of the UserSearch class.Constructor.

public UserSearch()

UserSearch(Id?)

Initializes a new instance of the UserSearch class.Constructor.

public UserSearch(Id? id)

Parameters

id Id

The user Id.

Properties

AuthenticationType

Gets or sets search for Users who are associated with this UserAuthenticationType.

public UserAuthenticationType? AuthenticationType { get; set; }

Property Value

UserAuthenticationType?

UserAuthenticationType The authentication type of the user.

AuthenticationTypes

Gets or sets search for Users who are associated with these UserAuthenticationTypes.

public List<UserAuthenticationType>? AuthenticationTypes { get; set; }

Property Value

List<UserAuthenticationType>

List<T>

CompanyGroups

Gets or sets search for Users who are a member of this GroupSearch. Available GroupSearch options are:. Cannot be used with DriverGroups.

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

Property Value

List<GroupSearch>

IList<T> The list of company groups.

DriverGroupFilterCondition

Gets or sets for Driver group list search.

public GroupFilterCondition? DriverGroupFilterCondition { get; set; }

Property Value

GroupFilterCondition

GroupFilterCondition

DriverGroups

Gets or sets search for Users who are assigned a Driver Key which is a member of the GroupSearch. Available GroupSearch options are:. Cannot be used with CompanyGroups.

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

Property Value

List<GroupSearch>

A list of IList<T> representing driver groups.

EmployeeNumber

Gets or sets search for a User who is associated with this Driver Employee Number. Wildcard can be used by prepending/appending "%" to string. Example "%EmployeeNumber%". This property is negatable. If the first character of this search property is '!', then the API will know to negate the search logic. (e.g. field = "!EmployeeNumber%", is equivalent to: WHERE NOT LIKE 'EmployeeNumber%')

public string? EmployeeNumber { get; set; }

Property Value

string

string The employee number of the driver.

FirstName

Gets or sets search for Users with this first name. Wildcard can be used by prepending/appending "%" to string. Example "%firstName%". This property is negatable. If the first character of this search property is '!', then the API will know to negate the search logic. (e.g. field = "!John%", is equivalent to: WHERE NOT LIKE 'John%')

public string? FirstName { get; set; }

Property Value

string

string The users first name.

FromDate

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

public DateTime? FromDate { get; set; }

Property Value

DateTime?

DateTime The active from date of a user.

HosRuleSet

Gets or sets search for Users who are associated with this HosRuleSet.

public HosRuleSet? HosRuleSet { get; set; }

Property Value

HosRuleSet?

HosRuleSet The HOS rule set of the driver.

HosRuleSets

Gets or sets search for Users who are associated with these HosRuleSets.

public List<HosRuleSet>? HosRuleSets { get; set; }

Property Value

List<HosRuleSet>

List<T>

IsDriver

Gets or sets only search for Users who have a Driver Key assigned.

[Obsolete("Use UserSearchType")]
public bool? IsDriver { get; set; }

Property Value

bool?

bool True if the user is a driver.

KeyId

Gets or sets search for a User who is associated with this Driver Key Id.

public long? KeyId { get; set; }

Property Value

long?

long A driver key Id.

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

LastLogin

Gets or sets for LastLogin search. Must be used with LastLoginComparator. If user's UserAuthenticationType is 'MyAdmin' and LastLoginComparator is 'After', user is returned regardless of LastLogin criteria. If user's UserAuthenticationType is 'MyAdmin' and LastLoginComparator is 'Before', user is not returned regardless of LastLogin criteria.

public DateTime? LastLogin { get; set; }

Property Value

DateTime?

LastLogin

LastLoginComparator

Gets or sets for DateTimeComparator for LastLogin search.

public DateTimeComparator? LastLoginComparator { get; set; }

Property Value

DateTimeComparator?

LastLoginComparator

LastName

Gets or sets search for Users with this last name. Wildcard can be used by prepending/appending "%" to string. Example "%lastName%". This property is negatable. If the first character of this search property is '!', then the API will know to negate the search logic. (e.g. field = "!John%", is equivalent to: WHERE NOT LIKE 'John%')

public string? LastName { get; set; }

Property Value

string

string The last name of the user.

LicenseNumber

Gets or sets search for a User who is associated with this Driver License Number. Wildcard can be used by prepending/appending "%" to string. Example "%LicenseNumber%". This property is negatable. If the first character of this search property is '!', then the API will know to negate the search logic. (e.g. field = "!LicenseNumber%", is equivalent to: WHERE NOT LIKE 'LicenseNumber%')

public string? LicenseNumber { get; set; }

Property Value

string

string The license number of the driver.

Name

Gets or sets search for Users with this email/log-on name. Wildcard can be used by prepending/appending "%" to string. Example "%name%". This property is negatable. If the first character of this search property is '!', then the API will know to negate the search logic. (e.g. field = "!John%", is equivalent to: WHERE NOT LIKE 'John%')

public string? Name { get; set; }

Property Value

string

string The name of the user.

SecurityGroups

Gets or sets search for Users who are assigned to a specific Security Clearance which is a member of the GroupSearch. Available GroupSearch options are:.

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

Property Value

List<GroupSearch>

A list of IList<T> representing driver groups.

SerialNumber

Gets or sets search for a User who is associated with this Driver Serial Number.

public string? SerialNumber { get; set; }

Property Value

string

string The serial number of the driver.

ToDate

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

public DateTime? ToDate { get; set; }

Property Value

DateTime?

DateTime The max date for the search.

UserGroupFilterCondition

Gets or sets for user group list search.

public GroupFilterCondition? UserGroupFilterCondition { get; set; }

Property Value

GroupFilterCondition

GroupFilterCondition

UserIds

Gets or sets search for Users with these unique Id(s). Not Supported for searching for users, only for TachographDataFile.

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

Property Value

IEnumerable<Id>

IEnumerable<T>

UserSearchType

Gets or sets for UserSearchType search.

public UserSearchType? UserSearchType { get; set; }

Property Value

UserSearchType?

UserSearchType