Namespace Geotab.Checkmate.ObjectModel
Classes
- A1
The Aptiv A1 device. Additional properties can be seen in GoCurveAuxiliary.
- AddInData
A class that holds data stored by an add-in.
- AddInDataSearch
The object used to specify the arguments when searching for AddInData.
- AddInDeviceLinkSearch
The object used to specify the arguments when searching for AddInDeviceLink.
- AddressLookupData
The address data looked up on the server.
- AddressZone
AddressZone
- AggregatedDataEntity
Base class for aggregated data container.
- AggregatedElectrificationData
Aggregated energy data for a vehicle.
- AggregatedElectrificationDataSearch
false search The object used to specify the arguments when searching for AggregatedFuelAndEnergyUsedData(s).
- AggregatedFuelAndEnergyUsedData
Data container for aggregated fuel used data.
- AggregatedFuelAndEnergyUsedDataSearch
false search The object used to specify the arguments when searching for AggregatedFuelAndEnergyUsedData(s).
- AggregatedIdlingData
Aggregated idling data for a vehicle.
- AggregatedIdlingDataSearch
The object used to specify the arguments when searching for a AggregatedIdlingDataSearch.
- AnnotationLog
An AnnotationLog is a comment that can be associated with a DutyStatusLog. The Driver is the author of the AnnotationLog.
- AnnotationLogSearch
The object used to specify the arguments when searching for AnnotationLog(s).
- ApiClientConfiguration
API Client configuration.
- ApiEntity
Represents the external-facing version of an entity with an identifier.
- ApplicationVersionInformation
The inner object for the ApplicationInformation information in VersionInformation.
- AssetInformationGroup
This is a system group see Group with an Id of GroupAssetInformationId. It is a group for all , see CustomReportSchedule. Each of these private scheduled group contains the individual users that are added manually as the report recipients.
- AssetUtilization
The object used to contain the asset utilization info.
- AssetUtilizationPreset
The preset for the asset utilization report.
- AssetUtilizationPresetSearch
The object used to specify the arguments when searching for AssetUtilizationPreset(s).
- AssetUtilizationSearch
The object used to specify the arguments when searching for a AssetUtilization.
- AssetUtilizationSummary
The object used to contain the asset utilization summary info.
- AssetUtilizationThresholds
The under and over utilized thresholds for the asset utilization report.
- Audit
Entry of events, operations and issues for tracking purposes. Entries can be added and read but cannot be edited.
- AuditSearch
The object used to specify the arguments when searching Audit entries.
- BackfillStatusModifiedException
If updating a BackfillStatus entity with the earliest processed date in the search criteria would cause a relationship exception then this exception is thrown.
- BatteryElectricVehicleGroup
This is a system group see Group with an Id of GroupBatteryElectricVehicleId. It is a child of ElectricHybridPluginGroup.
- BatteryStateOfHealth
Data pertinent to the monthly battery state of health analysis for a vehicle.
- BatteryStateOfHealthSearch
false search The object used to specify the arguments when searching for BatteryStateOfHealth(s).
- BeepContent
Message content to make the device beep.
- BigDataApiResult<T>
The big data API result.
- BigDataAverageRoadSpeed
The big data average road speed API result.
- BigDataError
The big data error.
- BigDataResult<T>
The big data result.
- BinaryData
This is binary data representing anything that can be stored. BinaryData can use this to store images but the data can be any custom data, including custom engine information types. The type of the data is defined by the BinaryDataType.
- BinaryDataSearch
The object used to specify the arguments when searching for BinaryData.
- BinaryPayload
A message containing a binary payload which is usually forwarded to a target device.
- BiodieselGroup
This is a system group see Group with an Id of GroupAssetInformationId. It is a child of InternalCombustionEngineGroup.
- BusinessGroup
This is a system group see Group with an Id of GroupBusinessGroupId. It is a group for all , see CustomReportSchedule. Each of these private scheduled group contains the individual users that are added manually as the report recipients.
- ByteConversionHelper
The DateTimeUtils class.
- CANMessageContent
The contents of a TextMessage containing data to give to a device connected to a CAN-IOX.
The CANMessageContent is a 'dumb pipe' type of message. Whatever data is put in the data property will be delivered, as is, to the system on the other end of the device connected to a CAN-IOX.
- CannedDeviceResponse
Represents a canned response to a text message for a device. Used by Garmin service.
- CannedResponseContent
Text message content including a list of predetermined responses. Derived from TextContent.
- CannedResponseOption
Specifies the allowed responses to a TextMessage.
- Certificate
An object representing a X509Certificate2 used to check if a message came from the correct external source.
- CertificateSearch
An object used to search for Certificates.
- ChargeEventJobProcessorServiceState
A class for storing job processing status as service state.
- ClientSettings
Settings that apply to client application.
- ColdChainContent
Generates message content to trigger changes on a cooling unit (e.g. reefer). For more details on how the data is sent to the device, see MimeContentBase.
- ColdChainContentNotSupportedException
This exception is thrown when there is an error with ColdChainContent types regarding unsupported actions
- ColdChainFaultClearContent
Generates message content to trigger the clearing of a fault code on a cooling unit (e.g. reefer). For more details on how the data is sent to the device, see MimeContentBase.
- ColdChainSetpointSetContent
Generates message content to trigger the setting of a setpoint on a cooling unit (e.g. reefer). For more details on how the data is sent to the device, see MimeContentBase.
- ColumnSelector
The class contains the collection of table field names. The Fields are matched on case-insensitive basis and included or excluded from the result, depending on IsIncluded flag.
- CommunicationLog
Log of communication attempts made.
- CompanyGroup
This is a system group see Group with an Id of GroupCompanyId and is the root group of the organization structure. The entire sub tree of this group is user defined.
- CompressedNaturalGasGroup
This is a system group see Group with an Id of GroupCompressedNaturalGasId. It is a child of InternalCombustionEngineGroup.
- ControlRequest
The format of requests sent to OEM Control service.
- Coordinate
A coordinate on the earth's surface. "x" is longitude and "y" is latitude.
- Credentials
The authentication credentials for a User used when making calls to MyGeotab.
- CubeDataChangeLog
The object model for containing the data related to change log for cube data
- CubeDefinition
Contains the dimension columns of the cube along with its type
- CubeInfo
The object model for containing the data related to generated cube metadata
- CurrencyConversionInfo
false A class containing currency conversion rates
- CustomData
Generic Custom Data from a GO unit that was sent through from a third-party device that is attached to the serial port.
- CustomDataSearch
The object used to specify the arguments when searching for CustomData.
- CustomDevice
A custom telematics device that is used in MyGeotab. This is used for extensibility and is based on the Device object.
- CustomKey
The class that represents Custom type key.
- CustomNfcKey
The class that represents NFC type key.
- CustomParameter
A custom parameter extends the parameters already supported by MyGeotab. This enables one to add a parameter to MyGeotab that is not explicitly supported in the user interface.
- CustomPropertySearch
A new search property for entities that support custom properties.
- CustomReportSchedule
Used to represent the schedule for emailed reports and dashboard graphic elements.
- CustomVehicleDevice
A custom telematics automotive vehicle device that is used in MyGeotab. This is used for extensibility and is based on the CustomDevice object.
- CustomWebMapProvider
Custom web map providers.
- CycleSummary
false CycleSummary.
- DVIRDefect
true A DVIRDefect is a Defect that can be associated with a DVIRLog. It contains repair information such as repair DateTime, repair , and . DVIRDefect also consists a list of which can be used to store additional information for the defect.
- DVIRDefectSearch
The object used to specify the arguments when searching for DVIRDefect(s).
- DVIRLog
A DVIRLog is a Driver Vehicle Inspection Report which is prepared by a driver regarding defects in parts of a vehicle associated with a Device or Trailer. Once the report is completed with optional driver remarks, the DVIR log will be acted upon, and marked as repairs made or not necessary (usually by another User). The driver then will mark the log as certified for being safe or unsafe to operate based on the effectiveness of any repairs made or comments for repairs not performed.
- DVIRLogSearch
true search The object used to specify the arguments when searching for DVIRLog(s). A trailerSearch and deviceSearch cannot be used at the same time because a DVIR log entry is only ever associated with one asset type (for instance, if the "device" is set, "trailer" is always null and vice versa).
- DataLog
Represents an estimate location for any data implementing IDateTimeProvider interface based on previous/next LogRecord and the DateTime.
- DataModeType
A unique identifier for different types of DataModeTypes. The DataModeType type can be one of the following "Unknown", "Public", "Private", or "PrivateStrict". It is for use with RestrictedDataModeChange only.
- DataPage<T>
Represents a page of data of records of type
T."/>
- DataToComponentContent
true Message that can deliver data to a component of a GO device.
- DateRange
A date range.
- DateRangeIntersect
This class that intersects a record with the DateRange(s). The DateRange(s) and each next record in sequence of the tested records have to be Date ordered in the same order, and the ranges must not intersect with each other.
- DateTimeComparer
false Reusable class to compare IDateTimeProviders.
- DateTimeEffectivityCheck
collection of methods to check if an entity is active in a given DateTime range.
- DateTimeWithTimeZone
An object with DateTime and TimeZoneInfo.
- DaySummary
false DaySummary.
- DbUnavailableException
This exception occurs if the system makes a database request that could not succeed because of connection failure or data change.
- DebugData
DebugData is generated by Geotab GO devices for internal debugging or troubleshooting purposes. This may include information regarding the state of the modem, firmware or conditions that the device is experiencing.
- DebugDataSearch
true search The object used to specify the arguments when searching DebugData.
- DefaultApplicationExceptionEmailTemplate
The default application exception email template.
- DefaultExceptionRuleEmailTemplate
The default rule exception email template.
- DefaultExceptionRulePopupTextTemplate
Default exception rule popup text.
- DefaultExceptionRuleTextTemplate
Default exception rule text.
- DefaultMaintenanceReminderEmailTemplate
The default maintenance notificaiton email template.
- Defect
Represents a Defect entity. This defines the one to one relationship between a DefectSeverity and Group.
- DefectRemark
true An DefectRemark is a remark that can be associated with a DVIRDefect.
- DefectRemarkSearch
The object used to specify the arguments when searching for DefectRemark(s).
- DefectSearch
The object used to specify the arguments when searching for a Defect.
- DefectsGroup
This is a Defect with an Id of GroupDefectsId. This is the root defect group for vehicle and trailer defects. The children of this group are not user defined.
- DeferralInfo
false RestInfo.
- Device
A Device represents the physical tracking device installed in the vehicle. A device and vehicle is typically synonymous since the GO tracking device is installed in a vehicle. In the case where there is no device; this is represented by "NoDeviceId". The device types that are supported are:
- DeviceCommunicationHealthServiceState
A class for storing device communication health service as service state.
- DeviceCommunicationStatus
Object model for the DeviceCommunicationStatus of a device.
- DeviceCommunicationStatusCount
Represents a record that holds the count of devices for a specific communication status.
- DeviceCommunicationStatusSearch
DeviceCommunicationStatusSearch that implements IEntity for DeviceCommunicationStatusSearch objects.
- DeviceConnection
Represents a connection from a GO device.
- DeviceCostSummary
false A class containing summarized costs of device maintenance
- DeviceDefaults
A helper class where all device defaults are contained. This allows us to reuse some of the defaults for non-related device objects. For example, GoLegacy and Go4V3 both have auxiliaries but are not in the same lineage.
- DeviceFlags
The plan a device is on.
- DeviceHelper
This class contains helper methods related to encoding and parsing device serial numbers and hardware IDs.
- DeviceLink
A DeviceLink is a relationship between two Devices over a period of time.
- DeviceLinkSearch
The object used to specify the arguments when searching for DeviceLink record(s).
- DeviceMasterFlag
The master flag of a device.
- DeviceMasterFlagSearch
search The object used to specify the arguments when searching for DeviceMasterFlag(s).
- DeviceParameterAttribute
Attribute to decorate device properties, when changed, should trigger parameter version increment and send to GO device.
- DevicePlanBillingInfo
Device Plan information holding the Plan name and Billing level mapping.
- DeviceSearch
The object used to specify the arguments when searching for a Device.
- DeviceShare
A device share represents the sharing of steaming data from a device into multiple databases. A database which is the primary device subscriber may share the data with one or many other databases.
- DeviceShareOptions
The class that contains device share options flags.
- DeviceShareSearch
The object used to specify the arguments when searching for DeviceShare(s).
- DeviceSourceAddressInfoSearch
The object used to specify the arguments when searching for DeviceSourceAddressInfo.
- DeviceStatus
A class that represents the current status for a Device, including last known Trip, last known StatusData and / or FaultData data where applicable.
- DeviceStatusFilterCondition
Device Status And/Or Filter object
- DeviceStatusInfo
Represents the current state of a vehicle by providing information such as the vehicle bearing location and speed, active exception events and whether the device is currently communicating.
- DeviceStatusInfoSearch
The object used to specify the arguments when searching for DeviceStatusInfo(s).
- DieselGroup
This is a system group see Group with an Id of GroupDieselId. It is a child of InternalCombustionEngineGroup.
- DirectCustomerEndpointServiceState
A class for storing Direct Customer invoker endpoint info as service state.
- DirectSupportException
This exception is thrown when MyAdmin needs to throw a friendly error message.
- Distance
false Used for converting distances between metric and imperial.
- DistributionList
A distribution list links a set of Rule(s) to a set of Recipient(s). When a Rule is violated each related Recipient will receive a notification of the kind defined by its RecipientType.
- DistributionListSearch
false search The object used to specify the arguments when searching for DistributionList(s).
- DistributionListSystem
System Distribution List.
- DriveUserSecurityGroup
This is a SystemSecurityClearance with an Id of GroupDriveUserSecurityId. A user see User that has this group assigned to its security groups will have access to all features of the Geotab Drive app.
- Driver
A driver in the system, and it is derived from User, with key ids and driver groups. If the driver is unknown then the driver is represented by "UnknownDriver".
- DriverActivityGroup
This is a system group see Group with an Id of GroupDriverActivityGroupId. It is a group for all , see CustomReportSchedule. Each of these private scheduled group contains the individual users that are added manually as the report recipients.
- DriverChange
Information about timing of a Driver change.
- DriverChangeSearch
The object used to specify the arguments when searching for a DriverChange.
This search defaults to searching DriverChange(s) by Driver Id when no DeviceSearch is provided.
- DriverRegulation
Detailed information for Hours of Service regulation for a driver.
- DriverRegulationSearch
true search The object used to specify the arguments when searching for DriverRegulation objects.
- DriverSystem
A driver that is a system driver.
- DummyAggregatedDataEntity
Dummy class for aggregated data container.
- DummyNestedObject
DummyCustomProperty class for setting custom properties in report headers
- DummyReportObject
Dummy object class for the dummy reports.
- DuplicateException
An exception that occurs when adding a new object or when updating an existing object that would cause a duplicate entry to occur.
- DuplicateKeyException
false An exception that occurs when adding a key to a user that is assigned to another user.
- DuplicateUserException
An exception that occurs when adding a new user or when updating an existing user would cause a duplicate.
- DutyStatusAvailability
Driver Availability for Hours of Service regulations.
- DutyStatusAvailabilityDuration
false The duration of time remaining for a specific DutyStatusViolationType.
- DutyStatusAvailabilitySearch
true search The object used to specify the arguments when searching for DutyStatusAvailability objects.
- DutyStatusCycleAvailability
Represents total cycle hours that will be available in the up coming days.
- DutyStatusLog
A DutyStatusLog is a record of duty status for Hours of Service regulations. The log is first required to have a driver, dateTime, status, and device. Location is not required and will be calculated from the device's data.
- DutyStatusLogComparer
false Class to compare DutyStatusLogs.
- DutyStatusLogSearch
true The object used to specify the arguments when searching for DutyStatusLog(s).
- DutyStatusRecap
Represents a single days total hours that count towards the cycle limit.
- DutyStatusViolation
A DutyStatusLog violation for a User.
- DutyStatusViolationSearch
true search The object used to specify the arguments when searching for DutyStatusViolation(s).This search has been designed to work efficiently with these combinations of parameters:
- ElectricHybridPluginGroup
This is a system group see Group with an Id of GroupElectricHybridPluginId. It is a child of PowertrainAndFuelTypeGroup and has its own sub-tree.
- EmailHelper
A helper class for validating users emails and creating emails.
- EmailTemplate
Stores custom email notifications.
- EmissionEnrollmentLoggingFrequencyType
Enum for emission enrollment logging frequency types NOTE: When updating this enum, please DO NOT change the values of the existing enum members, as the values are stored in database.
- EmissionReport
Class definition for EmissionReports.
- EmissionReportSearch
Search class for EmissionReports.
- EmissionReportSubmissionDetails
Class definition for EmissionReportSubmissionDetailss.
- EmissionReportSubmissionDetailsSearch
Search class for EmissionReportSubmissionDetailss.
- EmissionVehicleCycle
Class definition for EmissionVehicleCycles.
- EmissionVehicleCycleMessage
Class definition for EmissionVehicleCycleMessages.
- EmissionVehicleCycleMessageSearch
Search class for EmissionVehicleCycleMessages.
- EmissionVehicleCycleSearch
Search class for EmissionVehicleCycles.
- EmissionVehicleEnrollment
Class definition for EmissionVehicleEnrollments.
- EmissionVehicleEnrollmentSearch
Search class for EmissionVehicleEnrollments.
- Employee
The class representing an Employee.
- EmployeeRoutePlanSearch
false search The object used to specify the arguments when searching for EmployeeRoutePlan(s).
- EnableActiveTrackingServiceState
A class for storing enable active tracking service as service state.
- EndpointInfoServiceState
A class for storing invoker endpoint info as service state.
- EndpointMethodSettings
A class for holding settings for Endpoint Methods
- EnergySnapshotJobProcessorServiceState
A class for storing job processing status as service state.
- EngineDeviceStatus
false An extended version of DeviceStatus that includes a count of active FaultData and ExceptionEvent(s).
- EntitiesPerGroupResult
The count of entities by Group Id.
- Entity
true All objects that are stored in the database are entities. They are uniquely identified by their Id which is used later to Get, modify (Set) or Remove that object. The following entities are supported:
- EntityDateRange
Provides the instance of IEntity - derived class, "From" Date and "To" Date.
- EntityWithVersion
An Entity with a version.
- EqualityCheckHelper
A helper class for comparing objects.
- EthanolGroup
This is a system group see Group with an Id of GroupEthanolId. It is a child of InternalCombustionEngineGroup.
- EulaAcceptanceInfo
Stores EULA acceptance information.
- EventDeviation
false A particular occurrence of an EventDeviation.
- EventDeviationSearch
false search The object used to specify the arguments when searching for EventDeviation(s).
- EventOccurrence
false A particular occurrence of an MaintenanceSchedule.
- EventOccurrenceDue
false An upcoming event related to ab EventOccurrence.
- EventOccurrenceDueSearch
false search The object used to specify the arguments when searching for EventOccurrence(s).
- EventOccurrenceSearch
false search The object used to specify the arguments when searching for EventOccurrence(s).
- EventRule
The rule describing an event.
- EventRuleDevice
EventRule and Device.
- EventType
The type of an event.
- EventTypeElectricalSystemMaintenance
An event that occurs when the electrical system needs maintenance.
- EventTypeLeaseExpiry
An event that occurs when the lease expires.
- EventTypeLicensePlateExpiry
An Event that occurs when the license plate expires.
- EventTypeOilChange
An event that occurs when the oil needs to be changed.
- EventTypeTireRotation
An event that occurs when the tires need to be rotated.
- EverythingSecurityGroup
This is a SystemSecurityClearance with an Id of GroupEverythingSecurityId. User(s) that have this group assigned to their security groups means they have access to everything in the system.
- EwdAvailability
false Driver Availability for EWD.
- EwdRestPeriod
EWD Work/Rest Configuration for the Driver.
- EwdWorkPeriod
EWD Work/Rest Configuration for the Driver.
- EwdWorkRestConfig
EWD Work/Rest Configuration for the Driver.
- ExpiredPasswordException
This exception is thrown if a user makes a request while their ChangePassword flag is true. The user must change their password before they are able to successfully make further requests.
- FaultCycle
A class that holds the DTC cycles for a fault.
- FaultCycleSearch
false search The object used to specify the arguments when searching for FaultCycle(s).
- FaultRichData
A class that holds enrichment data for a fault.
- FaultRichDataSearch
search The object used to specify the arguments when searching for a FaultRichData.
- FeedResult<T>
true An object containing the result of a feed method.
- FeedVersionTrackingData
Represents the most recent records inserted into each table. This is used to ensure that the feed pulls the newest data possible without missing data.
- FeedVersionTrackingDataSearch
false search The object used to specify the arguments when searching for FeedVersionTrackingData(s).
- Feedback
Feedback that is collected for the purpose of data labeling.
- FeedbackSearch
false search The object used to specify the arguments when searching for a Feedback.
- FieldSelector
An abstract class for different types of field selectors.
- FileTypeException
false Exception for file type mismatch.
- FirmwareInfo
Information about a GoDevice firmware.
- FlashMemoryContent
Message content to flash memory.
- FleetComposition
The fleet composition for a demo database. Describes the attributes of the demo vehicles that will be simulated.
- FuelAndElectricConverter
false Converts fuel/electric volumes/totals/economies between to and from different units. Volumes/totals are always returned even if 0. Economies will return 0 if the input is 0 to prevent divide by 0 exceptions.
- FuelCellElectricVehicleGroup
This is a system group see Group with an Id of GroupFuelCellElectricVehicleId. It is a child of PowertrainAndFuelTypeGroup.
- FuelTaxAttributes
Fuel tax attributes.
- FuelTaxDetail
Fuel tax reporting element. The available driving history for a Device is stored as a sequence of such details. Each next detail starts when and where the previous detail ended. A detail is identified by its parameters (enter and exit time, odometer, GPS odometer, latitude and longitude) and its attributes (jurisdiction, Driver, toll road, authority). When any of the attributes changes, the current detail ends and a new detail begins. For more information, see IFTA Guide.
- FuelTaxDetailSearch
The object used to specify the arguments when searching for FuelTaxDetail elements.
This search has been designed to work efficiently with these parameters:
- GasolinePetrolGroup
This is a system group see Group with an Id of GroupGasolinePetrolId. It is a child of InternalCombustionEngineGroup.
- GenericException
This default exception returned undefined issues.
- Go10
The Geotab Go10 device. Additional properties can be seen in GoCurveAuxiliary.
- Go6
The Geotab GO6 device. Additional properties can be seen in GoCurveAuxiliary.
- Go7
The Geotab GO7 device. Additional properties can be seen in GoCurveAuxiliary.
- Go8
The Geotab GO8 device. Additional properties can be seen in GoCurveAuxiliary.
- Go9
The Geotab GO9 device. Additional properties can be seen in GoCurveAuxiliary.
- Go9B
The Geotab GO9B device. Additional properties can be seen in GoCurveAuxiliary.
- GoAnywhere
The GO Anywhere device. Additional properties can be seen in XDevice.
- GoCurveAuxiliary
Device that supports curve logging and auxiliaries. Additional properties can be seen in GoCurve.
- GoDriveDevice
A mobile tracking device that is used in MyGeotab. This is used for extensibility and is based on the Device object.
- GoLegacy
A legacy Geotab device is any GO device prior to Go5. Additional properties can be seen in GoDevice.
- GoTalkContent
The contents of a TextMessage that will be delivered to a GoTalk.
- Group
A group is one element in a hierarchical tree. Each group can have none or many children, it is the children that define the shape of the hierarchical tree. The parent is not a property of the group object and is only defined by who the group is a child of. It is necessary to know the id of the parent group when adding a new group.
There are three core Group branches used in MyGeotab. The most common are "Company Groups", company Groups are used to organize entities (Zone, User, Device, Driver and Rule) into logical groups related to the organization. A Group structure can be constructed by region, vocation, reporting or anything that makes sense to the business, this allows aggregate reports and rolling up data in a flexible way. These groups have a many to many type of relationship with the entities that are members and are not limited to one type of entity.
The second type is "Security Groups", these are Groups to which User(s) are members of and can only be applied to Users. Each Group has a list of SecurityFilter(s) associated to it. Security Filters control what parts of the application/API a User has access to.
The third type of group is a "Private User Group", this group is used only for scheduling reports and displaying dashboard reports for a User. This Group will only ever apply to one User and will typically be named the user's name.
There is a base structure of Groups which cannot be removed, these are considered to be "System"
Some of these groups are:
When Groups are retrieved they will always be in a flat list of groups. The hierarchically tree(s) can be reconstructed by looking at the "Children" property of each Group. The "Root" group will never be returned and is only for system use.
- GroupAssetUtilizationPreset
The metadata of the relationship between groups and asset utilization presets.
- GroupDevice
Represents a Group linked to a Device. This defines to the many to many relationship between a Device and Group.
- GroupDeviceSearch
The object used to specify the arguments when searching for a GroupDevice.
- GroupFilter
GroupFilter can be used to specify the type of operator (AND and OR) to use when searching for entities. The GroupsFilter option allows you to use more than one type of operator when searching for a specific group.
- GroupFilterCondition
GroupFilterCondition model the logic that govern a GroupFilter and can be used to specify the type of operator (AND and OR) to use when searching for entities. GroupFilterCondition are structured in hierarchical tree.
- GroupFilterEvaluator
Group filter evaluator, for evaluating GroupFilterCondition's.
- GroupFilterSearch
Search for a group filter
- GroupLinkedEntity<T>
Represents a Group linked to an IEntity. This defines to the many to many relationship between an IEntity and Group.
- GroupRelationViolatedException
Exception with information about the grouped linked entities that hold a relation preventing removal.
- GroupRelations
Used in GroupRelationViolatedException. When a user tries to remove a group but there are entities which are members of those groups the remove is blocked (fails) until the entities are moved out of the group which is to be removed. When the group remove operation fails, the exception returned is a GroupRelationViolatedException with populated GroupRelations to show which entities are blocking the group removal.
- GroupSearch
The object used to specify the arguments when searching for a Group.
- GroupSecurity
Represents a GroupSecurity entity. This defines the many to many relationship between a SecurityFilter and Group.
- GroupWithGlobalReporting
The base class for all groups that can be treated as global for reporting.
- GroupZoneMetadata
The metadata of the relatioship between groups and zones.
- GroupZoneMetadataSearch
The object used to specify the arguments when searching for a GroupZoneMetadata.
- HosRuleSet2
Hos Ruleset.
- HosRulesetConfig
The object used to specify the arguments when retrieving HosRulesetConfig(s).
- HosRulesetConfigParameters
The configuration parameters of HosRulesetConfig.
- HosRulesetConfigSearch
search The object used to specify the arguments when searching for HosRulesetConfig(s).
- HosRulesetCycleConfig
The cycle config.
- HosRulesetDailyConfig
Daily Configuration for the Driver.
- HosRulesetEarlyRestBreaks
The early rest breaks config.
- HosRulesetExemptionReducedRest
The work day Reduced Rest Exemption config
- HosRulesetRestConfig
Rest Configuration for HOS.
- HosRulesetWorkdayConfig
The work day config.
- HttpResponseMiddlewareHelper
Helper for common methods needed for building responses in response middleware
- IamCredentials
The IAM authentication credentials for a User used when making calls to MyGeotab.
- IdToKnownIdMapping
The mapping for an encoded Id to an KnownId.
- ImmobilizationContent
The message content to immobilize a device.
- ImportExportDistributionList
Distribution lists for Import/Export notifications.
- ImportTaskSearch
The object used to specify the arguments when searching for ImportTask(s).
- InactiveUserException
User is in active Exception.
- InternalCombustionEngineGroup
This is a system group see Group with an Id of GroupAssetInformationId. Each of these private scheduled group contains the individual users that are added manually as the report recipients.
- IntervalAggregatedEntity
Base class for interval aggregated data entities.
- IntervalAggregatedEntitySearch
false search The object used to specify the arguments when searching for IntervalAggregatedEntity(s).
- InvalidApiOperationException
This exception is thrown when a user attempts to perform an action that is not valid according to the API process.
- InvalidGroupFilterException
This exception is thrown when the group filter is invalid, possibly because of number of conditions.
- InvalidMyAdminUserException
This exception is thrown on a MyAdmin databaseName logon with an incorrect user/password combination or when the MyAdmin user's credentials become invalid on a databaseName.
- InvalidPermissionsException
This exception is thrown when a user attempts to perform an action without sufficient permissions.
- InvalidUserException
This exception is thrown on a logon with an incorrect user/password combination or when the user's credentials become invalid.
- IoxAddOn
Represents an Iox Add-On (like modem or navigation device) that is attached to a GO unit. Each Iox Add-On is assigned a channel - which is the serial port number that it typically communicates with.
- IoxAddOnSearch
search The object used to specify the arguments when searching for IoxAddOn(s).
- IoxAddOnStatus
Represents the status of an IoxAddOn that is attached to a GO unit.
- IoxAddOnStatusSearch
search The object used to specify the arguments when searching for IoxAddOnStatus(s).
- IoxOutputContent
The contents of a TextMessage that can be used to control the state of an IOX-OUTPUT.
- IoxServerInfo
Object that houses information by the IoxAddonServer
- IoxWorksConfigFileInfo
Represents the spreader config file info
- IoxWorksStatus
Represents all IOX-WRKS status information for an asset.
- JobProcessorServiceState
A class for storing job processing status as service state.
- KnownId
All the system Ids.
- KnownIoxAddOnType
A unique identifier for different types IoxAddOns. The range of valid values is between 4096 (inclusive) and 8192.
- Language
Type that represents language options
- LanguageDictionary
false Internal object for languages for lookup.
- LatestDeviceInfo
Latest info for a given device.
- LatestDeviceInfoFilter
Filter object for filtering APIs returning LatestDeviceInfo.
- LiveCompletionMapConfig
Route completion Live Map configuration which is a wrapper around all config time windows of a Group.
- LiveCompletionMapConfigSearch
Search object for LiveCompletionMapConfig.
- LiveCompletionTimeWindow
Represents a single time window withing in a LiveCompletionMapConfig.
- LocationContent
true Message content that can send a GPS location to a device. Derived from TextContent.To reset the location on a device, a location message with latitude/longitude 0 can be sent to the device.
- LogRecord
Record of log entries containing data for a device's position and speed at a specific date and time.
- LogRecordInterpolated
Represents an estimate location based on the previous/next LogRecord and a date.
- LogRecordSearch
true search The object used to specify the arguments when searching for LogRecord(s).
When searching for log records the system will return all records that match the search criteria and interpolate the value at the provided from/to dates when there is no record that corresponds to the date. Interpolated records are dynamically created when the request is made and can be identified as not having the ID property populated. Records with an ID are stored in the database.
This search has been designed to work efficiently with these combinations of parameters:
- LogRecordValidator
Used to validate if the log record is valid.
- LogRecordZoneDistance
Couples a LogRecord and a Zone objects with a distance between them in kilometers.
- LogRecordZoneDistanceSearch
search The object used to specify the arguments when searching for LogRecord from GPSZoneDistance page(s).
- LoginResult
true The results of an authentication attempt.
- MaintenanceNotificationRule
false An upcoming event related to ab EventOccurrence.
- MaintenanceNotificationRuleSearch
search The object used to specify the arguments when searching for IoxAddOn(s).
- MaintenanceNotificationState
false An upcoming event related to ab EventOccurrence.
- MaintenanceNotificationStateSearch
search The object used to specify the arguments when searching for IoxAddOn(s).
- MaintenanceSchedule
The rule describing an event.
- MaintenanceScheduleSearch
false search The object used to specify the arguments when searching for MaintenanceSchedule(s).
- MaintenanceTypeSummary
false A class containing summarized maintenance types
- ManuallyClassifiedPowertrainGroup
This is a system group see Group with an Id of GroupManuallyClassifiedPowertrainId. It is a child of PowertrainAndFuelTypeGroup.
This group is automatically assigned when there are user-made group assignments to any groups under PowertrainAndFuelTypeGroup. While present, the system will not assign any PowertrainAndFuelTypeGroups. It can be removed by a user to resume automatic assignment.
- MaxRoadSpeedResult
true Maximum road speed result.
- MemoryId
Populates IEntityId property with a value that allows to distinguish it from an entity that is not yet added to the database and prevents form an accidental db commit.
- MimeContent
The contents of a TextMessage containing data to give to a IOX Add-On over an RS232. It holds more data than SerialIoxContent and is not compatible with all Add-Ons. For more information regarding Add-On compatible please contact your reseller.
MimeContent is converted into bytes with a specific format. The first byte is the length of the MimeType (N). The next N bytes are the ASCII encoded bytes of the MimeType string. The next two bytes are the length of the Data (L). Finally, the next L bytes are the Data. Messages from MyGeotab will be delivered in this format and messages to MyGeotab must be in this format as well.
- MimeContentBase
The contents of a TextMessage containing data to give to a IOX Add-On over an RS232. It holds more data than SerialIoxContent and is not compatible with all Add-Ons. For more information regarding Add-On compatible please contact your reseller.
MimeContent is converted into bytes with a specific format. The first byte is the length of the MimeType (N). The next N bytes are the ASCII encoded bytes of the MimeType string. The next two bytes are the length of the Data (L). Finally, the next L bytes are the Data. Messages from MyGeotab will be delivered in this format and messages to MyGeotab must be in this format as well.
- MimeReferenceContent
A reference to data to be used as the contents of a TextMessage
Referenced will be converted into MimeContent prior to sending
- MimeTask
A task that has been created to facilitate additional processing of MimeContentTextMessages.false
- MimeTaskSearch
The object used to specify the arguments when searching for MimeTask(s).
- MimeTaskType
false A unique identifier for different types of MimeTasks that are executed for additional MimeContent processing.
- MimeTaskTypeApplicationMdf4
Specifies that the associated TextMessage should be processed by the application/mdf4 processor.
- MimeTaskTypeAutomotive
Specifies that the associated TextMessage should be processed by the automotive processor.
- MimeTaskTypeUnknown
Specifies that the processing task for the associated TextMessage is unknown.
- MimeTaskTypeVideoSafeway
Specifies that the associated TextMessage should be processed by the video/safeway processor.
- MissingDeviceEulaAcceptanceException
An exception that is thrown when a device is attempted to be added but a EULA needs to be accepted first.
- MyAdminBaseException
This exception is the base MyAdmin exception used when communicating with MyAdmin.
- NameEntity
An Entity that has a name field.
- NameEntityWithMaintenanceSource
The name entity with maintenance source.
- NameEntityWithVersion
An entity with a name and a version.
- NewsDistributionList
News Distribution List.
- NfcKey
The class that represents NFC type key.
- NoDriver
A driver object that represents no driver.
- NoRecipient
No Recipient.
- NoZone
A zone that represents DBNull database value.
- NothingSecurityGroup
This is a SecurityClearance with an Id of GroupNothingSecurityId. A User see User that has this group in its security groups means that there is no access to anything in the system. This is useful if you want to revoke access to the system or build upon this role and give access to a small set of items.
- Notification
false This class represents a notification that has to be send to a recipient.
- NotificationApplicationExceptionData
The notification data associated with application exceptions that the end user cannot control.
- NotificationAudioAlarmFile
Custom Notification Alert sound.
- NotificationBinaryFile
Notification binary file.
- NotificationData
The class represents data that is associated with a notification.
- NotificationDeviceShareData
Notification class for DeviceShare errors.
- NotificationDeviceShareDataInfo
Notification info for device share related communication.
- NotificationExceptionData
The notification data pertaining to Exception Rules.
- NotificationExceptionForUsersData
The notification data associated with application exceptions that can be resolved by user action.
- NotificationForAdminUsersData
The notification data associated with application notifications meant for admins.
- NotificationInfoData
The information data associated with a notification.
- NotificationMaintenanceReminderData
The notification data pertaining to Maintenance Reminders.
- NotificationMessageData
The message data associated with a notification.
- NotificationNewsData
The notification data pertaining to Exception Rules.
- NotificationNewsDataInfo
Notification info data for system news.
- NotificationNotifyException
The exception that occurs when sending a notification fails. Usually the result of a transient database issue. Receivers of this exception can retry.
- NotificationReportProcessorData
The information data associated with a notification.
- NotificationReportProcessorDataInfo
Notification info data for system news.
- NotificationSearch
false search The object used to specify the arguments when searching for Notification(s).
- NotificationUserModifiedData
A class for notifying of changes to a User by an administrator User. Provides information about who was changed, who did the changes, what type of changes happened, and any values that were changed if applicable.
Matching NotificationType is UserModified. Notifications of this type are only delivered to SystemNotice subscribers who have valid Group scope and SecurityIdentifier.
- OdometerResult
Represents an odometer value at a specific date and time.
- OemCredential
The format of credentials sent to OEM Middleware service.
- OldSessionInfo
false An internal class of old session info.
- OtauContent
The contents of a TextMessage containing data to give to a IOX Add-On over an RS232. It holds more data than SerialIoxContent and is not compatible with all Add-Ons. For more information regarding Add-On compatible please contact your reseller.
MimeContent is converted into bytes with a specific format. The first byte is the length of the MimeType (N). The next N bytes are the ASCII encoded bytes of the MimeType string. The next two bytes are the length of the Data (L). Finally, the next L bytes are the Data. Messages from MyGeotab will be delivered in this format and messages to MyGeotab must be in this format as well.
- OtherFuelGroup
This is a system group see Group with an Id of GroupOtherFuelId. It is a child of InternalCombustionEngineGroup.
- OverLimitException
Represents an exception thrown when a users has exceeded the query limit of an API.
- PasswordPolicyViolationException
Exception thrown when the password policy is violated.
- PerformanceValueExtensions
Performance Value Utility
- PerformanceValueProfiler
Performance Value
- PersonalGroup
This is a system group see Group with an Id of GroupPersonalGroupId. It is a group for all , see CustomReportSchedule. Each of these private scheduled group contains the individual users that are added manually as the report recipients.
- PluginHybridElectricVehicleGroup
This is a system group see Group with an Id of GroupPluginHybridElectricVehicleId. It is a child of ElectricHybridPluginGroup.
- PooledBufferedStream
A wrapped stream with custom flushing logic to ensure the buffer is cleared regularly.
- PowertrainAndFuelTypeGroup
This is a system group see Group with an Id of GroupPowertrainAndFuelTypeId. It is the root of a sub-tree of groups related to powertrain and fuel types.
See ManuallyClassifiedPowertrainGroup for special behaviour when Users assign any inherited groups.
- PresetSearch
false search The object used to specify the arguments when searching for Preset(s).
- PrivateScheduledReportGroup
This is a system group see Group with an Id of GroupPrivateScheduledReportId. It contains private groups for all scheduled reports, see CustomReportSchedule. Each of these private scheduled group contains the individual users that are added manually as the report recipients.
- PrivateUserGroup
This is a system group see Group with an Id of GroupPrivateUserId. It contains private groups for all users, see User. Each user ideally would one group under this group. This way, it will be easy to schedule a report or a dashboard for a user.
- ProcessedFuelJobProcessorServiceState
A class for storing job processing status as service state.
- PropaneLiquifiedPetroleumGasGroup
This is a system group see Group with an Id of GroupPropaneLiquifiedPetroleumGasId. It is a child of InternalCombustionEngineGroup.
- Property
The custom property of an entity that is customizable.
- PropertySearch
The search object for Property.
- PropertySelector
The class contains the collection of object property names. The fields are matched on case-insensitive basis and included or excluded from the result, depending on isIncluded flag.
- PropertySet
The property set that groups Property together based on a grouping structure.
- PropertySetSearch
The search object of the PropertySet class.
- PropertyValue<T>
The value of a custom Property for a given entity that supports custom properties.
- ProtobufCustomParameter
A protobuf custom parameter extends the custom parameter, make the custom parameter support newly defined Protobuf Parameters where a ParameterKey is used rather than a ParameterOffset. MYG-50560.
- ProtobufDeviceParameterAttribute
Attribute to decorate device properties, when changed, should trigger parameter version increment and send to GO device using Protobuf messages.
- RangeEstimate
Data pertinent to the range estimates for a vehicle.
- RangeEstimateSearch
false search The object used to specify the arguments when searching for RangeEstimates.
- Recipient
The recipient for a specific notification. A recipient is linked to Rule(s) via a DistributionList. When a Rule is violated the DistributionList linked recipient receives a notification. The type of recipient is defined by it's RecipientType. Not all properties of this object will have a value at the same time they are dependent on the RecipientType. Recipient is represented by the string "NoRecipientId" where there is no recipient.
- RecipientSearch
The object used to specify the arguments when searching for Recipient(s).false search
- RefreshToken
The refresh token class.
- Region
Type that represents a region option
- Regions
Class that holds static instances of region options
- RelationViolatedException
If removing an entity would cause a relationship exception then this exception is thrown.
- ReportProcessingRequest
Represents the report processing request
- ReportStorage
Stores the binary data for a generate excel report.
- ReportStorageAuthorization
The ReportStorageAuthorization links a report to a user who is authorised to view that report.
- ReportStorageSearch
The object used to specify the arguments when searching for ReportStorage(s).
- ReportTemplate
ReportTemplate class represents a template for reports that is an Excel file.
- ReportTemplateSearch
false search The object used to specify the arguments when searching for ReportTemplate(s).
- ReportTypedArgument
TypedArgument, all report arguments should be inherited from this class.
- RequestLocation
A message that requests the current location of a device through Iridium.
- ResellerInfo
Info about the reseller.
- RestInfo
false RestInfo.
- RestrictedDataModeChange
Indicates when a DataModeType was changed.
- RestrictedDataModeChangeSearch
search The object used to specify the arguments when searching for RestrictedDataModeChange(s).
- RestrictedDataModeType
Specifies only limited device data are allowed to be calculated and stored.
- ReverseGeocodeAddress
true The address and Zone (if any found) returned by a reverse geocode operation.
- Route
A connected sequence of zones which create a path for the vehicle to follow.
- RouteExtract
false A Device and date pair that represents the last time a particular RouteExtract has been executed for a specific vehicle.
- RouteExtractSearch
false search The object used to specify the arguments when searching for RouteExtract(s).
- RouteItem
Represents a LogRecord in proximity of a particular. RoutePlanItem
- RouteMatch
Represents a route matched to a device's driving activity.
- RoutePlanItem
The class representing an individual item in a planned Route.
- RouteSchedule
The class representing a relation between a Schedule and a Route.
- RouteSearch
The object used to specify the arguments when searching for Route(s).
- S1
The Go Anywhere Solar S1 device. Additional properties can be seen in GoCurveAuxiliary.
- SafetyFleetBenchmark
Data for a fleet cluster.
- SafetyFleetBenchmarkSearch
false search The object used to specify the arguments when searching for SafetyFleetBenchmark(s).
- SafetyFleetCluster
Represents a safety fleet cluster entity.
- SafetyFleetClusterSearch
false search The object used to specify the arguments when searching for SafetyFleetCluster(s).
- SafetyFleetInsight
Data for a fleet cluster
- SafetyFleetInsightSearch
false search The object used to specify the arguments when searching for SafetyFleetInsight(s).
- SafetyVehicleInsight
Data for a fleet cluster.
- SafetyVehicleInsightSearch
false search The object used to specify the arguments when searching for SafetyVehicleInsight(s).
- Schedule
The class representing a schedule.
- Search
true search Search that implements IEntity for search objects.
- SecurityClearance
Represents a Group with SecurityFilter(s) that are used to determine security access to different parts of the application.
To get all SecurityClearance(s), call the Get method with typeName Group and a GroupSearch with the Id property set to KnownId GroupSecurityId.
- SecurityFilter
true Represents an item that either Adds or Removes a particular SecurityIdentifier to a user's set of allowed items.
- SecurityGroup
This is a SystemSecurityClearance. The sub tree of this group is used to manage security to various parts of the system.
- SecurityId
For managing security identifiers.
- SecurityIdConverter
The converter for converting a SecurityId and SecurityIdentifier.
- SecurityIdSearch
false search The object used to specify the arguments when searching for SecurityId(s).
- SensorInfo
Sensor Info (subset of information from StatusData.
- SerialIoxContent
The contents of a TextMessage containing data to give to a third-party IOX Add-On over an RS232.
The SerialIoxContent is a 'dumb pipe' type of message. Whatever data is put in the data property will be delivered, as is, to the system on the other end of the IOX-RS232.
- ServiceState
The state of a service persisted as json.
- ServiceStateSearch
The object used to specify the arguments when searching for a ServiceState.
- ServiceUnavailableException
An exception thrown when an external service being called is unavailable.
- SessionInfo
The session info class.
- ShareableLink
false Internal class with the shareable link.
- ShareableLinkGroup
This is a system group see Group with an Id of GroupShareableLinkGroupId. It is a group for all , see CustomReportSchedule. Each of these private scheduled group contains the individual users that are added manually as the report recipients.
- ShareableLinkSearch
false search The object used to specify the arguments when searching for ShareableLink(s).
- ShareableLinkSettings
The shareable link settings.
- ShareableLinkState
The state the ShareableLink class
- ShareableLinkStateInProgress
The state the ShareableLink class
- ShareableLinkStateSucceed
The state the ShareableLink class
- ShipmentLog
A ShipmentLog is a record of shipment transported by a specified vehicle for a duration of time.
- ShipmentLogSearch
true search The object used to specify the arguments when searching for ShipmentLog(s).
- Sort
A generic implementation of ISort for sort fields that do not have a standardized SortField name. Being a generic implementation, there is no proper type validation for the offset field. It is recommended to use the appropriate ISort implementation instead when used for paging. For example, use SortById when sorting by "id". The recommended ISort implementations are:
- SortByDate
Implementation of ISort for sorting by the date field in Entitys.
- SortByName
Implementation of ISort for sorting by name field in Entitys.
- SortByStart
Implementation of ISort for sorting by the start date field in Entitys.
- SortByStop
Implementation of ISort for sorting by the stop date field in Entitys.
- SortByVersion
Implementation of ISort for sorting by the version field in Entitys.
- SortField
The standardized field names for use in sorting.
- SpeedLimitChanges
A list of speed limit change results.
- StatusDataLastValueBeforeCache
Represents the state of a vehicle's status data before the cache start time.
- StatusDataLastValueBeforeCache.Diagnostic
The record that will hold the StatusData.
- StatusDataLastValueBeforeCache.DiagnosticsDictionary
The dictionary type that will hold the StatusData.
- StatusDataRequestContent
Message to request status data.
- SupervisorSecurityGroup
This is a SystemSecurityClearance with an Id of GroupSupervisorSecurityId. A user see User that has this group in its security groups will have access to modify local data in the system. This is the type of user that does not need to administrate the system, but needs to create devices, zones, work times etc.
- SuspectEntityException
An exception for use within the Processor namespace only, which includes information about entities which violated foreign key constraints and caused a RelationViolatedException.
- SystemEmailTemplate
Email template for system.
- SystemGroupBase
The base class for all groups that are a system group.
- SystemSecurityClearance
The base class for SecurityClearance(s) that are system entities.
- SystemSettings
The settings related to the entire system.
- SystemUser
The internal user that has access to everything and is used internally by MyGeotab processes.
- TachographKey
The class that represents Tachograph type key.
- TempTrailerWithDevice
A temporary object until we deprecate Trailers
- TemporalCoordinate
A coordinate that is related to a DateTime.
- TextContent
true The contents of a GPS Text Message. See also:.
- TextMessage
- A message to send or received from a device. When working with text messages it is important to make the distinction between a "Reply" and a "Response".
- TextMessageContentType
The type of the text message content.
- TextMessageSearch
The object used to specify the arguments when searching for a TextMessage.
- TextTemplate
Stores custom text notifications.
- ThirdPartyHelper
This class contains helper methods related to encoding and parsing device serial numbers and hardware IDs.
- TimeZoneInfo
true Information about an Olson Timezone.
- TimeZoneInfoAdjustmentRule
Adjustment rule for timezones.
- TimeZoneInfoAdjustmentRule.TransitionTime
Transition time for adjustment rule.
- TimeZoneInfoWithRules
true Timezone info with its day light saving rules.
- Trailer
A trailer which can be attached and detached from a vehicle with a TrailerAttachment record.
- TrailerAttachment
A TrailerAttachment is a record of the attachment of a Trailer to a Device over a period of time.
- TrailerAttachmentSearch
true search The object used to specify the arguments when searching for TrailerAttachment record(s).
- TrailerSearch
search The object used to specify the arguments when searching for Trailer(s).
- Trip
This is a vehicles trip and a summary of the driving activity during that trip. To get more information about stops during a trip please see ExceptionEvent. A complete "trip" is defined as starting at the time in which the vehicle starts and begins being driven. The trip continues after the vehicle has been stopped and ends at the time the vehicle restarts and begins being driven again; which then starts the next trip.
- TripAnnotation
A class used to annotate a trip. Represents a comment at a moment in time for a device.
- TripAnnotationSearch
A class used to search for TripAnnotations.
- TripGeohash
false This stores unique geohash based on LogRecord for a Trip.
- TripGeohashSearch
The object used to specify the arguments when searching for a TripGeohash.
- TripSearch
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:
- TripSummary
The trip summary data for TripSummary report.
- TripTypeChange
Indicates when a TripType was changed.
- TripTypeChangeSearch
The object used to specify the arguments when searching for TripTypeChange(s).
- TripWithLogs
false A device trip.
- U1
The UReaderGPS U1 device. Additional properties can be seen in GoCurveAuxiliary.
- UIConfiguration
This object contains the users UI security configuration.
- UnknownDriver
The default unknown driver of a Device. Used if the driver is not identified through a key.false
- UnknownRestrictedDataModeType
Unsure about what device data are allowed to be calculated and stored.
- UnrestrictedDataModeType
Specifies all device data are allowed to be calculated and stored.
- UntrackedAsset
An untracked asset that is used in MyGeotab without a serial number. This is used for extensibility and is based on the Device object.
- UriValidator
A collection of common methods used to validate and work with System.Uris.
- UserDeviceLink
false
- UserDeviceLinkSearch
false search The object used to specify the arguments when searching for UserDeviceLink(s).
- UserHosRuleSet
A user's Hos Ruleset.
- UserHosRuleSetSearch
false search The object used to specify the arguments when searching for HosRuleSet objects.
- UserLoginStatus
User's Login status.
- UserLoginStatusSearch
false search The object used to specify the arguments when searching for a UserLoginStatus.
- UserModifiedInfo
A class representing extra data to be stored with a NotificationUserModifiedData and serialized into the Info column of the 'notificationdata' table.
- UserModifiedValueInfo
A class which represents data associated with NotificationUserModifiedData. This type holds additional information about properties of the User which were modified. It only applies to certain types of UserModification (see AreValuesRequired(UserModification?)).
- UserPasswordHash
A password hash. May represent a currently valid hash, or could represent a previous password hash that we are storing to prevent duplication. For internal use in the User bridge.
- UserRestrictedDataModeType
Specifies only limited device data are allowed to be calculated and stored. This mode prevents the DDIS from disabling restricted data mode.
- UserSearch
The object used to specify the arguments when searching for a User/Driver.
- UserSecurityGroup
This is a SystemSecurityClearance with an Id of GroupUserSecurityId. A user see User that has this group assigned to its security groups will have the default level of access.
- UserSessionInfo
false Internal class with the session info.
- UserSupport
A user's support.
- UserSupportSearch
false search The object used to specify the arguments when searching for a UserSupport.
- UserSystem
Base class for all system user types.
- UserValidationKeyInfo
Information on a user's validation key.
- UtilityValidator
Stand alone validation routines.
- ValidationKeyException
This exception is thrown when the process for validating a validation key fails.
- VehicleCommandContent
Message content to send VehicleCommands to a vehicle.
- VehicleConfigurationSearch
The object used to specify the arguments when searching for
VehicleConfiguration
- VehicleConfiguration<T>
VehicleConfiguration parameters entity.
- VehicleDayRoute
A summary of vehicle activity for a given route and day.
- VersionInformation
Software version information for the server.
- ViewMapOnlySecurityGroup
This is a SystemSecurityClearance with an Id of GroupViewMapOnlySecurityId. A user see User that has its group assigned to this security clearance will be able to View map, devices, drivers on the map.
- ViewOnlySecurityGroup
This is a SystemSecurityClearance with an Id of GroupViewOnlySecurityId. A user see User that have their security assigned to this group will only have access to view local data in the system. This user is unable to modify any data in the system and is the type of access that is recommended for users that need to view data in reports, tracking etc.
- Way
Represents a way or road segment in OSM.
- WayPathDetails
A list of way segments and details.
- WebClientError
This describes an error that the web Javascript client has.
- WebClientException
A client side exception to report to Sentry.
- WebRequestTemplate
URL template.
- WebServerHelper
Collection of static methods related to the web server that allows it to be used by other projects without referencing CheckmateServer.
- WifiHotspot
WifiHotspot is used to configure WiFi hotspot settings on telematics devices.
- WifiHotspotData
Parameters for WiFi hotspot.
- WifiHotspotSearch
The object used to specify the arguments when searching for a WifiHotspot.
- WifiUsageTier
Represents a specific usage tier for wifi hotspot rate plans.
- WorkHoliday
Day that is specified as not being a regular working day.
- WorkHolidaySearch
true search The object used to specify the arguments when searching for a WorkHoliday.
- WorkTime
The set of WorkTimeDetail(s) defining periods during the week that are considered as part of regular working hours. Work times that apply to all times are represented by "WorkTimeAllHoursId".
- WorkTimeAllHours
Declaration of an invariant singleton object WorkTimesAllHours.false
- WorkTimeDetail
The times during the week that are working times.
- WorkTimeEarlyLeaveHours
Represents Early Leave WorkTime hours.
- WorkTimeHolidayGroupId
true Work holidays. See WorkHoliday and WorkTime. Items can be grouped together by giving them all the same GroupId number.
- WorkTimeLateArrivalHours
Represents Late Arrival WorkTime hours.
- WorkTimeLunchHours
Represents Lunch WorkTime hours.
- WorkTimeSearch
true search The object used to specify the arguments when searching for a WorkTime.
- WorkTimeStandardHours
Represents the standard WorkTime hours.
- WorkTimeSystem
A work time that is a system supplied work time.
- WorkdaySummary
false DaySummary.
- Zone
Sometimes referred to as a "Geofence", a zone is a virtual geographic boundary, defined by its points representing a real-world geographic area.
- ZoneExtensions
The Zone extensions class.
- ZoneMetadata
The metadata of Zone.
- ZoneMetadataSearch
The object used to specify the arguments when searching for a ZoneMetadata.
- ZoneSearch
true search The object used to specify the arguments when searching for Zone(s).
- ZoneType
The type of the zone.
- ZoneTypeAddressLookup
A zone type that is for address lookup.
- ZoneTypeCustomer
A zone type that is a customer.
- ZoneTypeHome
A zone type that is a home zone.
- ZoneTypeInHouseServiceCenter
A zone type that is a in-house service center zone.
- ZoneTypeOffice
Zone Type that is an office zone.
- ZoneTypeSearch
true search The object used to specify the arguments when searching for ZoneType(s).
- ZoneTypeSystem
Base class for all system zone types.
- ZoneTypeVendorServiceCenter
A zone type that is a vendor service center zone.
Interfaces
- IAutoGroupsProvider
Models the properties of an entity with autoGroups.
- IContinuousConnectDevice
An interface for device that supports ContinuousConnect enable property
- ICredentials
Generic credentials object.
- ICustomizable<T>
An interface that dictates whether or not an Entity can have custom properties.
- IDateRange
A date range.
- IDateTimeProvider
An interface for an entity with a date.
- IDefaultable
Objects that can have default values populated without overriding properties which have values.
- IDeletedDateTimeProvider
An interface for an entity that can be marked as deleted.
- IDeviceProvider
The interface that is used to retrieve Device value from an object that implements this interface.
- IDigitalAuxiliaries
An interface for devices with digital auxiliaries
- IDriverChange
An interface that allows to access information about timing of a DriverChange.
- IDriverProvider
The interface that is used to retrieve Driver value from an object that implements this interface.
- IEngineHoursAdjustmentProvider
Models the properties of an entity with adjustable engine hours.
- IEngineHoursProvider
Models the properties of an entity that records engine hours.
- IEntity
All objects in database of the Geotab System are an entity. These have a unique identifier Id that can be used later to Get, modify (Set) or Remove that object.
- IEntityLink
An entity that provides entity link characteristics.
- IFuelProvider
An entity that provides fuel characteristics.
- IGoAnywhereDevice
An interface for Go Anywhere device's properties
- IGroupFilterEvaluator
Evaluates the group filter maximum conditions that are allowed and will throw InvalidGroupFilterException if above the maximum.
- IGroupLinked
An object that implements this interface has a relationship with Group(s). The object can be linked to one or more Group(s).
- IHOSDevice
Models the properties of an entity that supports HOS.
- IHosLog
The interface for all HOS and DVIR related logs.
- IIdentifiable
All objects in database of the Geotab System are an entity. These have a unique identifier Id that can be used later to Get, modify (Set) or Remove that object.
- IInstanceSizeEstimate
An interface class for getting instance size.
- IKnownError
This base exception interface that defines exceptions to be exposed publicly.
- ILastActive
The interface that is used to retrieve the isLastActive value from an object that implements this interface.
- ILicensable
Models an entity which is a license
- IMediaFiles
A list of media files.
- INullableRulesArgument
Argument that implements a list of rules.
- IObdAlertDevice
An interface for device that supports ObdAlertEnabled property
- IOdometerAdjustmentProvider
Models the properties of an entity with adjustable odometer.
- IOdometerProvider
Models the properties of an entity that records odometer.
- IRfChannels
An interface for devices with RF channels
- IRulesArgument
Argument that implements a list of rules.
- ISafetyInsight
The interface defining the common properties of Driver and vehicle safety insights
- ISimpleCoordinate
A simple coordinate on the earth surface. X is longitude and Y is latitude.
- ISimpleCoordinatesProvider
The interface that is used to retrieve ISimpleCoordinate value from an object that implements this interface.
- ISort
Sort criteria available through the public API, used to sort Entitys. Together with "resultsLimit" facilitates infinite scroll pagination. Check specific Entity for the sortable fields. If no sortable fields are specified then sorting is not supported.
- ITimeZoneIdProvider
The interface that is used to retrieve Date value from an object that implements this interface.
- ITrailerProvider
The interface that is used to retrieve Trailer value from an object that implements this interface.
- ITripDistance
Represents the Start, Stop, and Distance of a trip.
- IUserProvider
Interface used to retrieve an User instance from an object that implement this.
- IVehicleConfigurationData
The interface for implementing VehicleConfigurationData.
- IVehicleIdentificationNumber
An interface for devices with a Vehicle Identification Number (VIN).
- IVersion
Represents an entity which has a version
- IWorkTimeProvider
The interface that is used to retrieve WorkTime value from an object that implements this interface.
- IZoneProvider
The interface that is used to retrieve Zone value from an object that implements this interface.
- IZoneTypeProvider
The interface that is used to retrieve ZoneType value from an object that implements this interface.
Enums
- AssetUtilizationCategory
The asset utilization category.
- BinaryDataType
true Represents the specific binary format of data being stored in the BinaryData object.
- BinaryPayloadType
The BinaryPayload type.
- CalculationMethod
The enum for the type of CalculationMethod
- ColdChainContent.Protocols
Controller protocol values for various types of refrigeration units
- Continent
Continents list.
- CustomDataSections
The Custom Data Section enumeration. Custom data can be made up of three separate messages. This enumeration is used internally to identify which part(s) of the CustomData is being used.
- CustomPropertyEntityType
The entity types supported for Custom Properties
- CustomerClassifier
The classifier for customers
- DVIRLogType
true The type of DVIRLog.
- DatabaseState
The state that the database is currently operating in.
- DbUnavailableState
This Enum provides additional information about the reason for a database request could not succeed. or data change.
- DebugReason
LogRecord and DebugData reason codes. These codes are used for troubleshooting/debugging purposes only and should not be used for any programming logic. It is sometimes useful to understand why the Geotab GO device recorded information.
- DefectAssetType
The type of asset for which the list applies..
- DefectSeverity
true The severity of a defect for a DVIRLog.
- DeviceCommunicationStatusState
Object model for the DeviceCommunicationStatusState of a device.
- DeviceComponentType
The supported ComponentType values for DataToComponentContent Messages DataToComponentContent. Tells the device what to do with / where to send the data
- DeviceConnectionStatus
The state of the. DeviceConnection
- DeviceCustomFeature
Features that can be toggled for Devices that trigger different behaviour in MyGeotab.
- DeviceLinkType
The type of DeviceLink.
- DevicePlan
The Plans for Devices. Obsolete. Please use DevicePlanBillingInfo instead.
- DevicePlanMasterFlag
The master flags for Devices.
- DeviceShareStatus
The various statuses that a DeviceShare can have.
- DeviceShareType
Represents the data flow type for a DeviceShare.
- DeviceStatusLevel
The device status level. Used to indicate the "level" of severity for a device's status.
- DeviceType
The Geotab GO device type enumeration. Geotab has produced various types of tracking devices and this device type enumeration can be used to determine which type of hardware a particular device is.
- DriverChangeType
Supported Driver Change Types.
- DriverKeyType
The types of identification keys that can be assigned to a. DriverKey
- DrivingState
The current driving state of a vehicle.
- DueStatus
Status for EventOccurrenceDue
- DutyStatusDeferralType
The type of DutyStatusLog.
- DutyStatusLogType
true The type of DutyStatusLog.
- DutyStatusMalfunctionTypes
Malfunction or Diagnostic type of the DutyStatusLog.
- DutyStatusOrigin
true The origin of a DutyStatusLog.
- DutyStatusState
true The state of the DutyStatusLog record.
- DutyStatusViolationType
true The different types of DutyStatusViolation.
- EldTransferMode
false The type of EldTransferMode.
- EmissionComplianceStatus
Enum for emission compliance status NOTE: When updating this enum, please DO NOT change the values of the existing enum members, as the values are stored in database.
- EmissionReportSubmissionScheduleType
Enum for emission report submission schedule types NOTE: When updating this enum, please DO NOT change the values of the existing enum members, as the values are stored in database.
- EmissionReportType
Enum for Emission Report Types NOTE: When updating this enum, please DO NOT change the values of the existing enum members, as the values are stored in database.
- EmissionVehicleCycleFatalError
Fatal errors that prevent CARB cycles from being processed.
- EmissionVehicleEnrollmentFailureReason
Enum for emission vehicle enrollment failure reason NOTE: When updating this enum, please DO NOT change the values of the existing enum members, as the values are stored in database.
- EmissionVehicleEnrollmentStatus
Enum for emission vehicle enrollment status NOTE: When updating this enum, please DO NOT change the values of the existing enum members, as the values are stored in database.
- EncryptionType
The type of encryption.
- EosAssetMovementType
An enum for EOS device type
- EulaAcceptanceLevel
Indicates which level a EULA should be accepted at (e.g. once-per-company, once-per-user).
- FeatureEnvironment
An enum indicating the type of datastore feature environment.
- FeedbackStatus
An enum indicating the status of the feedback.
- FeedbackType
An enum indicating the type of feedback.
- FilterComparison
Filter comparison type.
- FuelTaxRoadType
Fuel tax road type.
- GeometryType
Defines the different geometry types of Zone(s).
- GeometryTypeSearch
false search The object used to specify the arguments when searching for Zone(s).
- GoTalkLanguage
The language used by a GoTalk attached to a. GoDevice
- GroupZoneMetadataType
Defines the different types of GroupZoneMetadata(s).
- HosOption
The HOS log generation options.
- IncludeGroups
The IncludeGroups enum provides a method of querying for entities relative to the entity's position in the hierarchy of Group(s). Some entity types (such as Zone(s)) have implications to entities in their child groups. For example; on a map, it may be useful to include Zone(s) that are above the user's data scope groups. These Zone(s) will also apply to vehicles that are at or below the selected Group(s) of the Zone.
- IntervalAggregateType
The type of aggregation for interval aggregated entities.
- InvalidGroupFilterType
An enum representing invalid group filter exception types.
- InvalidUserType
An enum representing invalid user exception types.
- JobProcessorStatus
Options for entity backfill status
- KeyType
false Supported Legacy Key Types.
- LogReason
GPSData and DebugData Log Reason codes.
- LoginRedirectTarget
false Target app for SSO authentication redirect.
- MediaFileType
The type of the media file.
- MessageContentType
The type of TextMessage content.
- NotificationBinaryFileType
The type of the data stored in NotificationBinary.
- NotificationStatus
The status of the notification.
- NotificationTemplatePurpose
The purpose of a notification template
- NotificationTokenType
Current available tokens to use in templates such as email template
- NotificationType
The type of Notification.
- PostedRoadSpeedOptions
Defines options for a posted road speed request.
- RecipientType
The type of notification message that is generated for a Recipient.
- RelayState
Enum for the possible relay states.
- RepairStatusType
true The Repair Status for DVIRDefect.
- ReportArgumentType
Enum to specify the type of the argument.
- ReportDataSource
Used to specify the type of the report template.
- ReportDestination
Used to specify where the destination of the scheduled report.
- ReportExtensionType
Report extension type (excel or ods) for ReportTemplate.
- ReportFrequency
The frequency with which reports can be generated.
- ReportPeriod
Used to represent the duration for which the report is generated.
- ReportProcessingStatus
The enum representing all the report processing statuses.
- ReportScheduleGroupType
The way to treat nodes in report schedule.
- ReportTemplateType
Report template type for ReportTemplate.
- RouteStatus
Route plan status
- ScheduleFrequency
Schedule Frequency.
- SearchRelation
Search the groups
- SecurityIdentifier
The list of identifiers that gives a security identity to something whose access can be controlled.
- SecurityRole
The security rights a user has. These are also used in Audit(s) as the action being audited.
- SortDirection
Sort direction.
- StopStatus
Route Stop status
- SupportedPropertyType
Denotes the supported types for a given Property .
- TripType
An enum indicating the type of a trip.
- UserAuthenticationType
The user authentication type.
- UserModification
An enum that describes possible types of User changes that require NotificationUserModifiedData to be created.
- UserSearchType
The type of UserSearchType to search for.
- UserSupportType
A type of User support contact. User contact can be call, training or procurement support
- ValidLoggingPeriod
The interval in which a Diagnostic reading is monitored, may be logged and the slope can be drawn between values and interpolated according to the slope of the line.
- ValidationKeyException.ExceptionReason
Enum describing reasons why this exception would occur
- VehicleCommand
An enum with a list of commands that can be sent to a vehicle via a VehicleCommandContent.
- VehicleConfigurationType
The type of
VehicleConfiguration
- VehicleFeatureCategory
The names of vehicle feature categories, including external devices detected by the device and features that are manually activated by the server.
- WebRequestTemplateHttpVerb
WebRequest Template Http Verb.
- ZoneMetadataType
Defines the different types of ZoneMetadata(s).