Skip to content

Latest commit

 

History

History
2743 lines (1722 loc) · 184 KB

README.md

File metadata and controls

2743 lines (1722 loc) · 184 KB

@fairfleet/geotab

@fairfleet/geotab

Table of contents

Functions

Enumerations

Classes

Interfaces

Type Aliases

Functions

createGeotab

createGeotab(options?): Geotab

Creates a Geotab instance from the given options.

Parameters

Name Type Description
options GeotabOptions The options to use.

Returns

Geotab

Defined in

src/index.ts:13

Type Aliases

AreaType

Ƭ AreaType: "None" | "Unspecified" | "CustomerSpecific" | "Database" | "Documentation" | "Drive" | "Eld" | "IoxAddOns" | "Language" | "Logging" | "MapServer" | "Notifications" | "ObjectModel" | "Optimization" | "Reports" | "RulesProcessor" | "Sdk" | "Serializer" | "UserInterface" | "UnitTests" | "WebServer"

Exception area type. This must match to the Error Reporting areas for the MyGeotab project.

Defined in

src/types/Log/AreaType.ts:6


BinaryDataType

Ƭ BinaryDataType: "None" | "Jpeg" | "Ascii" | "EngineSerialNumber" | "SoftwareVersion" | "CalibrationId" | "EcuMake" | "EcuModel" | "ManufacturerData" | "EcuManufacturerPartNumber" | "EcuManufacturerSerialNumber" | "SoftwareVersionSection1" | "SoftwareVersionSection2" | "SoftwareVersionSection3" | "SoftwareVersionFull" | "VariableEngineDataSnapshot" | "ThirdPartyData" | "ProximityCardEccKey" | "ReservationId"

Represents the specific binary format of data being stored in the BinaryData object.

Defined in

src/types/Checkmate/ObjectModel/BinaryDataType.ts:6


BinaryPayloadType

Ƭ BinaryPayloadType: "None" | "RequestLocation"

The BinaryPayload type.

Defined in

src/types/Checkmate/ObjectModel/BinaryPayloadType.ts:6


BusinessImpact

Ƭ BusinessImpact: "Unknown" | "Critical" | "Major" | "Moderate" | "Limited"

The business impact enum for support tickets.

Defined in

src/types/Checkmate/ObjectModel/DirectSupport/BusinessImpact.ts:6


ChargeType

Ƭ ChargeType: "AC" | "DC" | "Unknown"

Represents the current type of the charge.

Defined in

src/types/Checkmate/ObjectModel/Charging/ChargeType.ts:6


ConditionType

Ƭ ConditionType: "None" | "And" | "Or" | "Fault" | "ActiveOrInactiveFault" | "InsideArea" | "OutsideArea" | "Stop" | "ZoneStop" | "EnteringArea" | "ExitingArea" | "Aux1" | "Aux2" | "Aux3" | "Aux4" | "Aux5" | "Aux6" | "Aux7" | "Aux8" | "Ignition" | "DurationLongerThan" | "DurationShorterThan" | "DistanceLongerThan" | "DistanceShorterThan" | "DeviceWorkHours" | "AfterDeviceWorkHours" | "RuleWorkHours" | "AfterRuleWorkHours" | "Device" | "Driver" | "ApplicationException" | "InvertResult" | "FilterStatusDataByDiagnostic" | "IsValueMoreThan" | "IsValueLessThan" | "IsValueEqualTo" | "AnyData" | "ExpectedDuration" | "ExpectedDistance" | "TripDuration" | "Speed" | "TripDistance" | "Link" | "SpeedLimit" | "IsDriving" | "SpeedLimitExcludingEstimates" | "DurationBetweenGps" | "DistanceBetweenGps" | "SpeedLimitCommunity" | "SpeedLimitCommunityExcludingEstimates" | "SpeedLimitCommercial" | "SpeedLimitCommercialExcludingEstimates" | "ReferenceDate" | "DVIRDefect" | "NoDVIRCheck" | "EntireTrip" | "Inclusive" | "SpeedLimitAsMeasurement" | "NoPreDVIRCheck" | "NoPostDVIRCheck" | "IsValueMoreThanPercent" | "IsValueLessThanPercent" | "AverageRoadSpeed" | "SpeedLimitTruck" | "SpeedLimitTruckExcludingEstimates" | "SpeedLimitTruckCommunity" | "SpeedLimitTruckCommunityExcludingEstimates" | "SpeedLimitTruckCommercial" | "SpeedLimitTruckCommercialExcludingEstimates" | "InsideEachArea" | "WiFiTierUsage" | "WiFiMaxTierUsage" | "Group"

Defines the different types of Condition(s).

Defined in

src/types/Checkmate/ObjectModel/Exceptions/ConditionType.ts:6


Continent

Ƭ Continent: "Unknown" | "Asia" | "Africa" | "NorthAmerica" | "SouthAmerica" | "Antarctica" | "Europe" | "Australia"

Continents list.

Defined in

src/types/Checkmate/ObjectModel/Continent.ts:6


CubeType

Ƭ CubeType: "None" | "ExceptionEventByDevice" | "ExceptionEventByDriver" | "TripSummaryByDevice" | "TripSummaryByDriver"

The type of CubeType.

Defined in

src/types/Checkmate/ObjectModel/CubeType.ts:6


Currency

Ƭ Currency: "Cad" | "Hkd" | "Usd" | "Aud" | "Brl" | "Cny" | "Eur" | "Inr" | "Idr" | "Jpy" | "Myr" | "Mxn" | "Nzd" | "Nok" | "Pen" | "Php" | "Rub" | "Sar" | "Sgd" | "Zar" | "Krw" | "Sek" | "Chf" | "Thb" | "Twd" | "Try" | "Gbp"

The supported currency

Defined in

src/types/Checkmate/ObjectModel/Currencies/Currency.ts:6


CustomDataSections

Ƭ CustomDataSections: "None" | "A" | "B" | "C" | "Header" | "All"

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.

Defined in

src/types/Checkmate/ObjectModel/CustomDataSections.ts:6


CustomPropertyEntityType

Ƭ CustomPropertyEntityType: "Device" | "User"

The entity types supported for Custom Properties

Defined in

src/types/Checkmate/ObjectModel/CustomPropertyEntityType.ts:6


CustomerClassifier

Ƭ CustomerClassifier: "None" | "Government"

The classifier for customers

Defined in

src/types/Checkmate/ObjectModel/CustomerClassifier.ts:6


DDISDebugLogArea

Ƭ DDISDebugLogArea: "CacheWindow" | "RecordCount" | "Trips" | "ExceptionCalculation"

Level of debug to be controlled by DDISLoggingServiceState.

Defined in

src/types/Checkmate/Database/DDISDebugLogArea.ts:6


DVIRLogType

Ƭ DVIRLogType: "Unknown" | "PreTrip" | "PostTrip" | "InTrip"

The type of DVIRLog.

Defined in

src/types/Checkmate/ObjectModel/DVIRLogType.ts:8


DataSourceKind

Ƭ DataSourceKind: "None" | "Any" | "LogRecord" | "FaultData" | "StatusData" | "NotificationDataApplicationException" | "ExceptionEvent" | "Numeric" | "WorkTime" | "DVIRDefect"

Kinds of data sources for Conditions.

Defined in

src/types/Checkmate/ObjectModel/Exceptions/DataSourceKind.ts:6


DatabaseInfoComponent

Ƭ DatabaseInfoComponent: "DatabaseName" | "SystemSettingsReadMillis" | "LogRecordReadMillis" | "EntityCountMillis" | "LastUserAccessReadMillis" | "DatabaseLocationMillis" | "UploaderStatsMillis" | "OutsideComponentsMillis"

Components for info and performance evaluation.

Defined in

src/types/Checkmate/ObjectModel/Web/DatabaseInfoComponent.ts:6


DatabaseMaintenancePeriod

Ƭ DatabaseMaintenancePeriod: "Unknown" | "None" | "Day" | "Week" | "TwoWeeks" | "Month" | "TwoMonths" | "ThreeMonths" | "SixMonths" | "Year" | "Forever" | "Continuous" | "ThreeYears" | "ThirteenMonths" | "FourteenMonths" | "FifteenMonths" | "SixteenMonths" | "SeventeenMonths" | "EighteenMonths" | "NineteenMonths" | "TwentyMonths" | "TwentyOneMonths" | "TwentyTwoMonths" | "TwentyThreeMonths" | "TwoYears" | "SevenMonths" | "EightMonths" | "NineMonths" | "TenMonths" | "ElevenMonths" | "TwelveMonths" | "TwoDays" | "ThreeDays" | "FourDays" | "FiveDays" | "SixDays" | "FourYears" | "EightYears"

The period being used in database maintenance.

Defined in

src/types/Checkmate/Settings/DatabaseMaintenancePeriod.ts:6


DatabaseState

Ƭ DatabaseState: "Unknown" | "Inactive" | "Active" | "Deletion"

The state that the database is currently operating in.

Defined in

src/types/Checkmate/ObjectModel/DatabaseState.ts:6


DatabaseTransferStatus

Ƭ DatabaseTransferStatus: "None" | "Idle" | "InProgress" | "AlreadyInProgress" | "LimitExceeded"

The current database transfer status.

Defined in

src/types/Checkmate/ObjectModel/Database/DatabaseTransferStatus.ts:6


DateTimeComparator

Ƭ DateTimeComparator: "Before" | "AfterOrEqual"

The DateTimeComparator.

Defined in

src/types/Checkmate/ObjectModel/DateTimeComparator.ts:6


DbUnavailableState

Ƭ DbUnavailableState: "None" | "ConnectionFailure" | "UnknownDatabase" | "Initializing" | "OperationAborted"

This Enum provides additional information about the reason for a database request could not succeed. or data change.

Defined in

src/types/Checkmate/ObjectModel/DbUnavailableState.ts:9


DebugReason

Ƭ DebugReason: "Unknown" | "ErrorRestartRfStateMachine" | "ErrorRestartRfManagerStateMachine" | "ErrorRestartWifiStateMachine" | "ErrorRestartWifiManagerStateMachine" | "ErrorRestartGsmcdmaStateMachine" | "ErrorRestartModemManagerStateMachine" | "ErrorRestartGpsStateMachine" | "ErrorRebootSlave" | "ErrorClockStopped" | "VoltageFluctuation" | "SlaveVersionReported" | "BootloaderFirmwareUpdate" | "DebugGpsShutdown" | "DebugHotStartAttempt" | "DebugHotStartValid" | "DebugHotStartFail" | "DebugNoGpsData" | "IoxRelay" | "IoxSleepEvent" | "IoxPollResult" | "IoxAuxAutoReport" | "IoxUnitTestDebug" | "IoxDebug" | "DebugHeartbeatSuccess" | "DebugHeartbeatFail" | "IoxAuxRequestReport" | "IoxAuxStates" | "IoxAuxLogicStatus" | "ThirdPartyUpdate" | "ExcessiveEngineDataReceived" | "AidingDataReceived" | "AidingDataProcessed" | "EngineProtocolDetectAttempt" | "GpsVersion" | "DebugBuzzer" | "DebugLed" | "RpmTimeout" | "EngineOff" | "DebugEngineProtocol" | "ThirdPartyDeviceDetected" | "AlmanacDataRequested" | "AlmanacAllocationError" | "AlmanacInvalid" | "AlmanacUpdateReceived" | "CalculatedGpsSpeed" | "GpsValidWithZeroLatLong" | "CanTransmitErrorExceeded" | "HybridVehicleDetected" | "ActiveEngineFaultsRequested" | "PendingEngineFaultsRequested" | "GmLanRoadSpeed" | "DebugLegacyManager" | "MemoryAllocationError" | "MemoryPointerErrorDebug" | "WifiInRange" | "WifiConnected" | "WifiUploadSuccess" | "WifiOutofRange" | "WifiConfigUpdateFailed" | "SleepEvent" | "SensomatixDataReceived" | "SensomatixDataSent" | "SensomatixServerAcknowledge" | "SensomatixDataAllocationError" | "RpmDebug" | "EngineCommunicationDisabled" | "EngineProtocolDetectedNewCode" | "TwoWireBasedIgn" | "EngineBasedIgn" | "LiveMode" | "PassiveMode" | "GsmInfoSent" | "EnginePidSupportDebug" | "OdometerDebug" | "PowerDebug" | "SensomatixSaveParam" | "SendingThirdPartyHandshake" | "ThirdPartySyncCharReceivedWhileIdle" | "AccelerometerInVehicleAudibleAlert" | "J1708DebugData" | "HoursOfServiceInfoMessageReceived" | "ThirdPartyMessageTooLong" | "AidingDataStart" | "GpsDataNoLongerValid" | "GpsDataNowValid" | "RpmBasedIgn" | "RunTimeBasedIgn" | "RoadSpeedBasedIgn" | "EngineIgnOnSwitchStatus" | "EngineIgnOffSwitchStatus" | "ExcessiveFirmwareUpdateAttempts" | "RelayDebug" | "SeatbeltDebug" | "UnknownLiveMessageType" | "RestartApnScanningDebug" | "RfRequestFirmware" | "GmLanFaultCodeDebug" | "MovementDetected" | "MovementTimeout" | "PositionChanged" | "IridiumRecordCreated" | "IridiumModemConfigured" | "IridiumRetry" | "IridiumSendingData" | "IridiumTransmitSuccess" | "GmLanEngineStatus" | "CanMessageOverFlowDebug" | "IridiumPollReceived" | "ClockStartDebug" | "ModemConnectDelayedPoorGsmSignal" | "ReplyToGsmInfo" | "LoggingParametersUpdated" | "ModemManagerDebug" | "AccelerometerAudibleEvent" | "GprsUrlResolved" | "GprsConnectedToServer" | "GprsReplyToHelloReceived" | "GprsConnectionDropped" | "GprsConnectingTimeout" | "GprsSendingDataTimeout" | "GprsErrorResolvingUrl" | "GprsConnectingToServer" | "GprsReplyToHello" | "CellNetworkRegistration" | "GprsTcpipStackStarted" | "GprsAttachedToGprs" | "GprsApnSet" | "GprsApnUsernameSet" | "GprsApnPasswordSet" | "GprsConnectionToApnStarted" | "GprsServerPortSet" | "GprsServerAddressSet" | "GprsActivatedGprsResponseMode" | "GprsModemNotReady" | "GprsModemPowerOff" | "GprsRequestParams" | "GprsRequestGsmParams" | "GprsModemPowerOn" | "ReplyToGsmHello" | "GprsModemNotAvailable" | "GprsModemDisconnecting" | "GprsModemManagerRetry" | "GprsRequestFirmware" | "GprsFirmwareReply" | "GprsFirmwareUpdateFailed" | "GprsDataReadInitialisationFailed" | "GprsReceiveBufferOverrun" | "GprsFirmwareUpdateSuccess" | "GprsNoModemDetected" | "GprsGsmModemDetected" | "GprsCdmaModemDetected" | "GsmCdmaModemRestart" | "GsmCdmaModemManagerRestart" | "GprsWindReceived" | "LiveHspaModemDetected" | "LiveWifiModemDetected" | "LiveLeonModemDetected" | "WifiLiveFirmwareInit" | "WifiLiveFirmwareUpdate" | "WifiLiveUpdateSuccess" | "WifiLiveUpdateFail" | "LiveUnsolicitedResponseCodeWhileConnected" | "WifeLiveReconnect" | "AuxDebug" | "DebugInvalidGsmParameters" | "DataToComponentMessageReceived" | "CanNonDelayBufferOverrun" | "UbloxReadRetry" | "InvalidRoadSpeedDuringReverseDetect" | "J1708FaultDebug" | "LiveModemRetry" | "RfTransmitFailed" | "InVehicleAudibleAlert" | "WifiLiveFirmwareVersion" | "GpsSignalStrengthReceived" | "InvalidMsgTypeDuringFirmwareUpdate" | "InvalidMsgTypeDuringParameterUpdate" | "InvalidMsgTypeDuringThirdPartyFirmwareUpdate" | "InvalidMsgTypeAfterInitialConnect" | "InvalidMsgTypeAfterSendingMultilogBatch" | "InvalidMsgTypeAfterAidingDataRequest" | "RadioFirmwareUpdateFailedDuringRequest" | "RadioFirmwareUpdateFailedInsufficientData" | "RadioFirmwareUpdateFailedInvalidMsgType" | "RadioFirmwareUpdateFailedInvalidBlockCount" | "IoxAdded" | "IoxInfo" | "IoxRemoved" | "IoxSleep" | "IoxWakeUp" | "IoxBootloadInfo" | "DriverIdKeyDisabled" | "ReverseDetectionStarted" | "ReverseMovementConfirmed" | "OutOfReverseZeroSpeed" | "OutOfReverseHighSpeed" | "OutOfReverseExcessiveAcceleration" | "ReverseMovementDetected" | "OutOfReverseForwardAcceleration" | "ReverseNotConfirmedDueToForwardAcceleration" | "ReverseNotConfirmedDueToZeroSpeed" | "ConfirmReverseDetectStage1" | "UcdmaModemDetected" | "UcdmaModemProvisioningDebug" | "Can1ReceiveBufferFull" | "Can2ReceiveBufferFull" | "DebugVoltageCurveErrorIncrease" | "DebugGpsJammingWarning" | "DebugGoDeviceDistance" | "DebugUnknownIridiumUrc" | "DebugIsoInitData" | "DebugIncreaseBroadcastRpmTimeout" | "DebugGpsExcessiveTimeToFirstFix" | "DebugEngineIgnOnHybrid" | "DebugClearCodesAttempt" | "DebugClearCodesSuccess" | "DebugClearCodesModeEnabled" | "DebugEngineIgnOffHybrid" | "DebugEngineDataDetected" | "DebugWiredInAuxDetected" | "DebugFuelSystemStatus" | "DebugSeatbeltResponse" | "DebugOdometerResponse" | "DebugInReverseHighSensitivity" | "DebugErrorRestartGps" | "DebugErrorRebootSlave" | "DebugErrorRestartRf" | "DebugErrorRestartRfManager" | "DebugErrorRestartWifi" | "DebugErrorRestartWifiManager" | "DebugErrorRestartModem" | "DebugErrorRestartModemManager" | "DebugGpsAntennaStatusError" | "DebugErrorClockStopped" | "DebugFlashFail" | "DebugErrorStackPtrInvalid" | "DebugErrorIntOff" | "InvalidDate" | "ResetRecord" | "GpsDebugDeprecated" | "UnknownData" | "InvalidJ1708DataLength" | "Garbage" | "InvalidStatusDataLength" | "TooManyInvalidGps" | "FutureDate" | "InvalidCoordinate" | "InvalidFaultData" | "ResetGo3" | "ZeroDiagnosticCode" | "InvalidVin" | "InvalidAccelerationData" | "ObdiiDebugCode" | "InvalidCustomRecord" | "DuplicateMonitorRecordRemoval" | "AuxRecordForDebug" | "ModemSignalStrengthVeryLow" | "IsoInitTimeout" | "IsoTimeoutWaitingForSyncChar" | "Obd2DuplicateMessageInBuffer" | "CanDuplicateMessageInBuffer" | "InvalidJ1708TotalFuel" | "InvalidJ1708TotalDistance" | "FuelRateDetected" | "LowThresholdEventsCancelled" | "ModemNetworkApn" | "ModemConnectionSuccess" | "ModemApnAttachFail" | "ModemResolveUrlFail" | "ModemOpenSocketFail" | "ModemManagerRetryFail" | "ModemNetworkFail" | "InvalidGpsReason" | "SeatbeltRequest" | "OdometerRequest" | "SeatbeltConfidenceLevel" | "SeatbeltResponseChangeMidTrip" | "SeatbeltBuckledStateTripTimers" | "IgnitionType" | "ValorIdFault" | "ValorTpmsFault" | "MobileyeCarData" | "MobileyeTsr1" | "MobileyeTsr2" | "MobileyeTsr3" | "MobileyeTsr4" | "MobileyeTsr5" | "MobileyeTsr6" | "MobileyeTsr7" | "MobileyeVisionDisplay1" | "MobileyeVisionDisplay2" | "MobileyeVisionDisplay3" | "MobileyeVisionDisplay4" | "Mode10DiagnosticInitiated" | "SwitchJ1939ToCan3" | "ActiveTrackingMode" | "ForceReset" | "OdometerUnitsNotVerifiedDeprecated" | "VinRequestDisabled" | "VinRequestCounterExceeded" | "Can3SetTo500K" | "WifiCommsError" | "CdmaResolveUrlFailure" | "AccelerometerSaveFirstPoint" | "J1708InvaludIdleFuel" | "UBXChecksum" | "ThreeWireIgnChange" | "SetServerIndex" | "SetNextServerIndex" | "FordTransitElectricProtocolSet" | "SeatbeltPotentiallyFlashing" | "CanSwitchToListenOnlyModeWithNoErrors" | "CanSwitchToNormalModeWithNoErrors" | "EngineDataMaxRequestsWithNoResponseFromBus" | "EngineDataDetectedAsBroadcast" | "EngineDataDetectedAsRequestResponse" | "EngineDataDetectedAsLateBroadcast" | "SpeedDetectedBeforePowerOffDeprecated" | "SpeedDetectedBeforePowerOffCounterResetDeprecated" | "SpeedDetectedBeforePowerOffCounterIncrementedDeprecated" | "SpeedDetectedBeforePowerOffRequestsDisabledDeprecated" | "ResponseReceivedAfterMaxRetries" | "RequestResponseDetectionError" | "ModemSignalStrength" | "ModemCdmaPrlId" | "SendAddonsDetectedMessage" | "InitServerDetai" | "SetServerUnavailable" | "OscSwitch" | "InterSleepTime" | "AccelerometerInterruptFailure" | "CanBufferOverrun" | "CanTxErrorCountExceeded" | "EngineOffAfterVinRequest" | "ExcessiveAccelerometerEvents" | "ExcessiveAccelerometerLogsInEvent" | "ExcessiveEngineData" | "ExcessiveLegacyCommunicationErrors" | "ExcessiveLogging" | "SlaveRestart" | "GpsConfigurationFailure" | "HighVoltageWhileIgnOff" | "InvalidKeyInsert" | "IsoReceiveStateInvalid" | "J1708BufferFull" | "J1708TransmitAlreadyEnabled" | "J1708CommunicationError" | "J1708Lm317Failure" | "J1708MessageTooLarge" | "J1708RxBufferOutOfSync" | "J1708RxStateFail" | "J1708TransmitSuccess" | "J1708TransmitActive" | "J1708TransmitBufferOutOfSync" | "J1850ReceiveStateInvalid" | "J1850TransmitStateInvalid" | "J1850TransmitTimeout" | "J1939Debug" | "MemoryPointerError" | "ObdReceiveBufferOutOfSync" | "ObdReceiveBufferFull" | "ObdTransmitBufferOutOfSync" | "ObdTransmitBufferFull" | "RestartApnScanning" | "RestartModemStateMachine" | "ScantoolMemoryFull" | "J1850TimeoutWaitingForIdle" | "LegacyTimerOffWithoutCts" | "TooManyLogsInMultilog" | "RestartRfStateMachine" | "RestartRfManagerStateMachine" | "NonDelayCanBufferOverrun" | "RestartWifiStateMachine" | "RestartWifiManagerStateMachine" | "RfFirmwareRequestFailed" | "RfFirmwareUpdateTimeout" | "RfFirmwareUpdateFailedExpectedAckMsg" | "RfFirmwareUpdateFailedInvalidBlockCount" | "J1708InvalidFault" | "J1708MessageTooLong" | "GpsStreamingViaCanEnabled" | "DevicePotentiallyKnocked" | "UbloxModemPowerOffDebug" | "GpsStreamingCantAllocateMemory" | "MaxNumberOfEngineParametersExceeded" | "EngineCurveCantAllocateMemory" | "EngineDataPriorityCantAllocateMemory" | "GeotabKeyImageCantAllocateMemory" | "Q26ExtreemeDebug" | "J1850TransmitActive" | "IsoTransmitActive" | "ExcessiveLoggingToAccidentMemory" | "InvalidTotalFuelUsedData" | "J1850VpwCommunicationError" | "J1850PwmCommunicationError" | "InvalidAlmanacDataInFlash" | "CanDisabled" | "CanTransmitError" | "DeviceInterferenceDuringFirmwareUpdate" | "DivideByZero" | "J1850VpwTransmitError" | "J1850PwmTransmitError" | "CanReceiveError" | "CanFmsError" | "InvalidScantoolMessageLength" | "CanReceiveErrorsDetected" | "CanNormalMode" | "CanListenOnly" | "InsufficientRamAvailable" | "CanTransmitTimeout" | "CanTransmitErrorsDetected" | "CanRxErrorCountExceeded" | "RadioInvalidMsgTypeDuringParameterUpdate" | "RadioInvalidMsgTypeDuringThirdPartyFirmwareUpdate" | "RadioInvalidMsgTypeAfterInitialConnect" | "RadioInvalidMsgTypeAfterSendingMultilogBatch" | "RadioInvalidMsgTypeAfterAidingDataRequest" | "InvalidGsmParameters" | "UndefinedJ1939Controller" | "UndefinedJ1708Mid" | "GmSwcCantAllocateMemory" | "ExcessiveTimeToFirstFix" | "ClockFailAtStartup" | "ModemTimeoutWaitingForRts" | "IoxOverCurrent" | "CanBusOffState" | "CanBusErrorState" | "CanBusWarningState" | "InvalidSpeedFilter" | "SpeedResetToZero" | "DeviceNotGoingToSleep" | "FirmwareInflateFailed" | "VwInitializationFail" | "VwApplicationTypeNotSupported" | "VwApplicationTypeTemporarilyNotSupported" | "VwNoResourcesAvailable" | "VwTimeoutWhileIdle" | "VwKeepAliveCounterExceeded" | "VwTransmitBufferOutOfSync" | "VwReceiveBufferOutOfSync" | "VwStartCommunicationInvalidResponse" | "VwReceiveBufferFull" | "VwTransmitBufferFull" | "VwInitializationFailedStage2Failed" | "VwTransmitTimeout" | "VwCantAllocateMemory" | "VwInitRetryCounterExceeded" | "SeatbeltStateCounterExceeded" | "CanTransmitBufferFull" | "CanTransmitBufferOutOfSync" | "UbloxInvalidReadResponse" | "J1708CantAllocateMemory" | "InvalidLoggingParameters" | "LogDataChecksumFailure" | "J1708TransmitError" | "FlashErrorStage1" | "OdometerNotDetected" | "InvalidJ1708TxLength" | "Obd2RxBufferOutOfSync" | "Obd2NegativeResponse" | "Obd2SeatbeltRequestResponseMismatch" | "Obd2OdometerRequestResponseMismatch" | "Obd2SeatbeltReportingError" | "Obd2OdometerReportingError" | "TwoWireIgnDetectDisabled" | "InvalidSensomatixLength" | "GpsJammingDetected" | "IsoTimeoutWaitingToInitialize" | "IsoAddressByteTxError" | "IsoTimeoutWaitingForSyncCharDeprecated" | "IsoTimeoutWaitingForKeywords" | "IsoTransmitError" | "IsoUnsupportedKeywords" | "IsoTimeoutWaitingForInverseAddressByte" | "IsoFastInitError" | "IsoInitializationNotDefined" | "IsoNoResponseToStartComm" | "IsoInvalidResponseToStartComm" | "J1850TxActiveProtocolNotSet" | "SeatbeltNotChangingState" | "ModemSignalStrengthLow" | "IsoInitializationTimeout" | "InvalidSensomatixHardwareid" | "Obd2RxPointerInvalid" | "Obd2TxPointerInvalid" | "Obd2DuplicateMessageInBufferDeprecated" | "CanDuplicateMessageInBufferDeprecated" | "CurveEngineIncorrectDatetimeLogic" | "IoxResetFault" | "AccelerometerCommunicationRecovered" | "AccelerometerCommunicationFailure" | "J1708ExcessiveIdleHours" | "J1939ExcessiveIdleHours" | "ScantoolDetected" | "CurveDataRatioZero" | "CurveTimeRatioZero" | "AlmanacDataOffsetTooLarge" | "IoxBootloadFault" | "IsoInitTimerOff" | "StackOverflowProtection" | "SubscribeToEventFail" | "AttemptToRaiseEventFromEvent" | "DeviceHasRamErrors" | "ExcessiveSeatbeltChanges" | "UnsubscribeFromEventFail" | "SensomatixLengthExceedCdmaTxLimit" | "SingleObd2EcuOnly" | "J1708TxPointerInvalid" | "J1708TxBufferError" | "J1708TxTimeout" | "J1708TxInvalidLength" | "J1708TxBufferFull" | "IoxBootloaderFound" | "CurrentCommunicationRecovered" | "CurrentCommunicationFailure" | "ObdWithJ1939" | "RamManagerDataOverrun" | "InvalidPidSupportData" | "IoxFirmwareTooLargeForBootloaderV1" | "CanRequestedModeIsInvalid" | "CanTxStateUnknown" | "NextCanModeOverwritten" | "ExternalDeviceInfoCantAllocateMemory" | "Obd2SeatbeltCantAllocateMemory" | "J1708SlaveTxCantAllocateMemory" | "J1708TxCantAllocateMemory" | "AccelerometerExcessiveReEnable" | "GpsIgnOffBufferOverflow" | "AccelPurgingBuffers" | "VwFuelRate" | "OdometerInvalid" | "OdometerInMetricVerified" | "OdometerInImperialVerified" | "GoDeviceIdPotentiallyInvalid" | "MafMessagesMissedCount" | "CurveIterationStackFull" | "UbloxSpecialUdConfig" | "CdmaCarrierDetectionError" | "ModemRegistrationDenied" | "ModemHelloMessageReply" | "ModemApnFailed" | "ModemApnIndexFromGeozone" | "CanSwitchToListenOnlyMode" | "ExtCanErrorsDetected" | "ExtCanOverrunErrorsDetected" | "EngineBasedRoadSpeedDisabled" | "PotentialFalseSeatBeltDetect" | "UnknownIntelligentHarness" | "VinCountNotSupported" | "CaterpillarVehicleDetected" | "ExcessiveOdometerVariance" | "Obd2VpwInvalidRpm" | "CanSpeedLocked" | "FirmwareValidated" | "FirmwareValidationFailed" | "CaterpillarDataParseError" | "CaterpillarStateMachineError" | "CaterpillarRxError" | "CaterpillarDataInvalid" | "CaterpillarDisabled" | "CaterpillarEngineHoursDetected" | "ExtCanOff" | "CanBroadcastAddress" | "InvalidGpsDateTime" | "ScanToolIdsFromEngine" | "GeoZoneDetected" | "FuelTypeUnknown" | "DebugFuel" | "Can2BootProcessInitiated" | "Can2BootProcessCompleted" | "DeveloperDebugTrapError" | "CaterpillarDataBusIdleTimeout" | "InvalidCoolantLevel" | "ModemPowerOffState" | "CaterpillarDiagnosticCode" | "ExcessiveVoltageData" | "ExcessiveDebugData" | "ValidJ1708DataDetected" | "IntelligentHarnessDetectInvalidHarness" | "GpsInvalidChecksumCount" | "MapMissedMessageCount" | "IoxFirmwareChecksumFailed" | "ExcessiveThirdPartyData" | "CAN1InListenOnlyMode" | "FuelPulseInvalid" | "BmwFuelAirRatio" | "ResultsFromMode6Test" | "MinMaxValuesFromMode6Test" | "Mode6MidSupport" | "ValorTrailerTrackingCantAllocateMemory" | "ExcessiveValorTrailerTrackingId" | "FuelConsumptionIgnoredDueToBufferLimit" | "InvalidFuelConsumptionDetected" | "Mode6InitialTimestamp" | "Mode6CurrentTimestamp" | "EngineDataSource" | "MtkModemUnexpectedReset" | "NullVinSavedWithNoEngineProtocol" | "TooManyRxErrorsInShortPeriodNormalMode" | "TooManyRxErrorsInShortPeriodListenOnlyMode" | "OdometerResponsePending" | "SwcTxBufferFull" | "SwcTxBufferOutOfSync" | "CurrentCurveErrorIncrease" | "MultilineResponseTimeout" | "Can3FailedGoingIntoNormalModeForTx" | "Can3TxFailed" | "Can3ExcessiveErrors" | "SwcTxFailed" | "MultilineResponseBusy" | "J1939MultilinePackedOutofSync" | "CantAllocateNewParameterForGenericTimestamp" | "IntermittentConnectionTestProtocolCanObd" | "IntermittentConnectionTestProtocolCanJ1939" | "IntermittentConnectionTestProtocolJ1708" | "IntermittentConnectionTestProtocolJ1850" | "IntermittentConnectionTestProtocolSwc" | "IntermittentConnectionTestProtocolFiat50K" | "IntermittentConnectionTestProtocolUndefined" | "IntermittentConnectionDetectedSevere" | "IntermittentConnectionDetectedWarning" | "IntermittentConnectionDetectedNotification" | "IntermittentConnectionTestAddressUsed" | "UnknownThirdPartyMessageType" | "ThirdPartyIoxCanAckFailed" | "IncorrectThirdPartyMessageLength" | "FuelTypeNotAvailable" | "StandardEngineDetected" | "TurbochargedEngineDetected" | "SuperchargedEngineDetected" | "J193911bitRequestsStopped" | "FuelDebug" | "J1708PoorConnectionQuality" | "HardwareTesterIoxDebug" | "BaseModeFaultCode" | "CanBusStatusAtIgnitionOn" | "CanBusStatusDuringTrip" | "CanBusStatusAtIgnitionOff" | "CanBusStatusBetweenTrips" | "CanBusStatusStateUnknown" | "CanLinesPotentiallyFloatingWithoutCanSpeedLocked" | "HwTesterIoxDataRecordLost" | "SwcTxMessageTooLong" | "EngineDataNotBeingRequested" | "J1708BusBusyErrorCount" | "RamManagerOverwritten" | "OdometerUnitsNotVerified" | "ExcessiveRxCanErrorsInLongPeriodOfTime" | "ExcessiveTxCanErrorsInLongPeriodOfTime" | "ExcessiveRxCanErrorsInShortPeriodOfTime" | "ExcessiveTxCanErrorsInShortPeriodOfTime" | "CanLinesPotentiallyFloatingWithCanSpeedLocked" | "InvalidJ1708EngineRoadSpeed" | "UnknownSwcProtocol" | "LegacyManagerTriedASwcProtocol" | "SwcTooLongOfAMessage" | "RemoteScanToolMessageFromServer" | "ExtcanBusCorrect" | "ExtcanErrorsDuringIntialization" | "ExtcanBusOff" | "ScantoolSessionExpired" | "ScantoolSessionConnected" | "UnableToUseRequestedScantoolProtocol" | "PossibleCanTransceiverFailureInNormalMode" | "PossibleCanTransceiverFailureInListenOnlyMode" | "SpeedDetectedBeforePowerOff" | "SpeedBeforePowerOffCounterReset" | "SpeedDetectedBeforePowerOffCounterIncremented" | "SpeedDetectedBeforePowerOffRequestsDisabled" | "StoppedReceivingRequestResponse" | "MaxEngineDataTypeLimitExceeded" | "EngineDataTypeDisabled" | "ExtcanModeFailureDuringInit" | "ExtcanUnknownInitializationState" | "ExtcanWaitingOnMessageToInitialize" | "ScantoolTimeoutTryingToInitialize" | "DuplicateSwcMessage" | "DuplicateCan3Message" | "PotentialFalse6PinHarnessDetect" | "HardwareIdCorruptionAfterMemoryRead" | "Spi2TimeoutExtcanOff" | "ExtcanTooManyInterruptErrorsExtcanOff" | "ExtcanFailedWakingUp" | "ExtcanInternalRxBufferOverrun" | "ExtcanInternalRxBufferCorruption" | "LegacyChecksumFailureCount" | "HardwareIdCorruptionFirmware" | "Can3FunctionPointerNull" | "OscNotSwitching" | "ProprietaryDataSeenButNotRequestedByUs" | "Can2FlashPageExtraction" | "FlashEraseCommandReceived" | "J1708DuplicateMessageInBuffer" | "ReportingPreviousVinDueToIntermittentConnection" | "RxCanErrorsExceededExtremeThreshold" | "TxCanErrorsExceededExtremeThreshold" | "InvalidAcclerometerCalibration" | "ExcessiveSingleDebugDataLogging" | "DebugDataDump" | "MaxValue"

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.

Defined in

src/types/Checkmate/ObjectModel/DebugReason.ts:9


DefectAssetType

Ƭ DefectAssetType: "All" | "Device" | "Trailer"

The type of asset for which the list applies..

Defined in

src/types/Checkmate/ObjectModel/DefectAssetType.ts:6


DefectSeverity

Ƭ DefectSeverity: "Normal" | "Critical" | "Unregulated"

The severity of a defect for a DVIRLog.

Defined in

src/types/Checkmate/ObjectModel/DefectSeverity.ts:8


DeviceComponentType

Ƭ DeviceComponentType: "UartPassthrough" | "Aux" | "Relay" | "Buzzer" | "DataPoll" | "FlashMemory" | "Output" | "DriverList" | "VehicleCommand" | "CanPassthrough" | "EcuUpdate" | "PassthroughEnabled" | "WorkshopMode"

The supported ComponentType values for DataToComponentContent Messages DataToComponentContent. Tells the device what to do with / where to send the data

Defined in

src/types/Checkmate/ObjectModel/DeviceComponentType.ts:9


DeviceConnectionStatus

Ƭ DeviceConnectionStatus: "Active" | "Disconnected" | "Inactive"

The state of the. DeviceConnection

Defined in

src/types/Checkmate/ObjectModel/DeviceConnectionStatus.ts:6


DeviceCustomFeature

Ƭ DeviceCustomFeature: "AutoHos"

Features that can be toggled for Devices that trigger different behaviour in MyGeotab.

Defined in

src/types/Checkmate/ObjectModel/DeviceCustomFeature.ts:6


DevicePlan

Ƭ DevicePlan: "Unknown" | "Pro" | "Passive" | "Base" | "VinOdometer" | "HOS" | "BaseEngine" | "ProPlus" | "ProNoGps" | "EnterpriseStandard" | "RentalMode1" | "ApiSafety" | "ApiMaintenance" | "ApiBase" | "ApiPro" | "SafetyOdo" | "Maintenance" | "BaseFuel" | "ProPlusWinterOps" | "ProPlusCarShare" | "ProPlusWifi" | "BaseEngineDtc" | "Safety" | "Suspend" | "Terminate" | "Sb" | "FuelBIStandard" | "ZenduMaint" | "D2GODriverChallengeStandard" | "OFHMaintTriage" | "OFHMaintStayfit" | "R4MeNotify4MeBase" | "R4MeNotify4MePro" | "R4MeDispatch4MeBase" | "R4MeDispatch4MePro" | "R4MeOptimization4MeBase" | "R4MeOptimization4MePro" | "ZenduMaintBasic" | "ZenduMaintPro" | "R4MeBasic" | "GeotabDataSciencePackage" | "SawatchezEV" | "SurfsightON1" | "SurfsightON2" | "DataConnector0" | "DataConnector50" | "DataConnector100" | "DataConnector125" | "DataConnector150"

The Plans for Devices. Obsolete. Please use DevicePlanBillingInfo instead.

Defined in

src/types/Checkmate/ObjectModel/DevicePlan.ts:9


DevicePlanMasterFlag

Ƭ DevicePlanMasterFlag: "Unknown" | "EnableAccelerometer" | "EnableAlmanacData" | "EnableAnalog" | "EnableAuxiliaries" | "EnableBluetooth" | "EnableCoolant" | "EnableDevice" | "EnableDriverKey" | "EnableEngineCommunications" | "EnableEngineHours" | "EnableEngineManagement" | "EnableEngineRoadSpeed" | "EnableEngineSnapshot" | "EnableFuel" | "EnableGpsLogging" | "EnableHighResLogging" | "EnableHosData" | "EnableLive" | "EnableMobileye" | "EnableOdometer" | "EnableOil" | "EnableOutput" | "EnablePassthrough" | "EnableRpmLogging" | "EnableSaltSpreader" | "EnableSatellite" | "EnableScanTool" | "EnableSeatbelt" | "EnableTachographLog" | "EnableTextToSpeech" | "EnableThirdParty" | "EnableValorData" | "EnableVehicleFaults" | "EnableVoltageReading" | "EnableWiFi" | "EngineRetarderSelection" | "ReduceEngineDataLogging" | "ReduceFuelLevelLogging" | "ReduceGpsLogging" | "SaveClutchPedalState" | "SaveEngineLoad" | "EnableEVData" | "EnableLocation"

The master flags for Devices.

Defined in

src/types/Checkmate/ObjectModel/DevicePlanMasterFlag.ts:6


DeviceReportedChargingState

Ƭ DeviceReportedChargingState: "NotCharging" | "ACCharging" | "DCCharging" | "ChargingUnknownSource"

The charging state as reported by the device.

Defined in

src/types/Checkmate/ObjectModel/Charging/DeviceReportedChargingState.ts:6


DeviceShareStatus

Ƭ DeviceShareStatus: "Pending" | "Active" | "Rejected" | "Cancelled" | "Terminated" | "Error" | "RequestTerminated" | "RequestApproved" | "RequestDeclined" | "RequestCancelled" | "RequestPending"

The various statuses that a DeviceShare can have.

Defined in

src/types/Checkmate/ObjectModel/DeviceShareStatus.ts:6


DeviceShareType

Ƭ DeviceShareType: "Incoming" | "Outgoing"

Represents the data flow type for a DeviceShare.

Defined in

src/types/Checkmate/ObjectModel/DeviceShareType.ts:6


DeviceStatusLevel

Ƭ DeviceStatusLevel: "Critical" | "Warning" | "Good" | "Disabled" | "Unknown"

The device status level. Used to indicate the "level" of severity for a device's status.

Defined in

src/types/Checkmate/ObjectModel/DeviceStatusLevel.ts:6


DeviceType

Ƭ DeviceType: "None" | "OldGeotab" | "GO2" | "GO3" | "GO4" | "GO4v3" | "GO5" | "GO6" | "GO7" | "GO8" | "GO9" | "GO9B" | "CustomDevice" | "GoDriveDevice" | "CustomVehicleDevice" | "A1" | "U1"

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.

Defined in

src/types/Checkmate/ObjectModel/DeviceType.ts:6


DiagnosticType

Ƭ DiagnosticType: "None" | "Sid" | "Pid" | "GoDiagnostic" | "DataDiagnostic" | "SuspectParameter" | "ObdFault" | "GoFault" | "ObdWwhFault" | "ProprietaryFault" | "LegacyFault" | "GmcccFault" | "BrpFault" | "AiModel" | "LevcFault"

Diagnostic source type of the diagnostic.

Defined in

src/types/Checkmate/ObjectModel/Engine/DiagnosticType.ts:6


DriverChangeType

Ƭ DriverChangeType: "None" | "DriverKey" | "DriverVehicleChange" | "TripDriver" | "Driver" | "ResetDriver"

Supported Driver Change Types.

Defined in

src/types/Checkmate/ObjectModel/DriverChangeType.ts:6


DriverKeyType

Ƭ DriverKeyType: "Usb" | "Nfc" | "CustomNfc" | "Tachograph" | "Custom"

The types of identification keys that can be assigned to a. DriverKey

Defined in

src/types/Checkmate/ObjectModel/DriverKeyType.ts:6


DrivingState

Ƭ DrivingState: "None" | "Driving" | "IdlingOrDrivingSlowly" | "Stopped" | "Idling" | "Parked"

The current driving state of a vehicle.

Defined in

src/types/Checkmate/ObjectModel/DrivingState.ts:6


DtcClass

Ƭ DtcClass: "Unclassified" | "A" | "B1" | "B2" | "C"

Represents a severity/class code from the engine system of the specific Device.

Defined in

src/types/Checkmate/ObjectModel/Engine/DtcClass.ts:6


DtcSeverity

Ƭ DtcSeverity: "MaintenanceOnly" | "CheckAtNextHalt" | "CheckImmediately"

Represents a severity/class code from the engine system of the specific Device.

Defined in

src/types/Checkmate/ObjectModel/Engine/DtcSeverity.ts:6


DutyStatusDeferralType

Ƭ DutyStatusDeferralType: "None" | "DayOne" | "DayTwo"

The type of DutyStatusLog.

Defined in

src/types/Checkmate/ObjectModel/DutyStatusDeferralType.ts:6


DutyStatusLogType

Ƭ DutyStatusLogType: "ON" | "OFF" | "D" | "SB" | "Exemption16H" | "AdverseWeather" | "Connected" | "Disconnected" | "PC" | "YM" | "WT" | "Authority" | "Login" | "Logoff" | "Certify" | "EnginePowerup" | "EngineShutdown" | "EnginePowerupPC" | "EngineShutdownPC" | "PowerCompliance" | "EngineSyncCompliance" | "TimingCompliance" | "PositioningCompliance" | "DataRecordingCompliance" | "DataTransferCompliance" | "OtherCompliance" | "MissingElementCompliance" | "UnidentifiedDrivingCompliance" | "INT_PC" | "INT_D" | "SituationalDrivingClear" | "ExemptionOffDutyDeferral" | "HosEnabled" | "HosDisabled" | "PC_Exempted" | "CanadaCycleOne" | "CanadaCycleTwo" | "OperatingZoneCanadaSouthOf60" | "OperatingZoneCanadaNorthOf60" | "OperatingZoneAmerica" | "INT_CoDriver" | "Work" | "Rest" | "WorkExemption" | "RailroadExemption"

The type of DutyStatusLog.

Defined in

src/types/Checkmate/ObjectModel/DutyStatusLogType.ts:8


DutyStatusMalfunctionTypes

Ƭ DutyStatusMalfunctionTypes: "None" | "Diagnostic" | "Malfunction" | "UserClear" | "UserDiagnosticClear" | "UserMalfunctionClear" | "SystemClear" | "SystemDiagnosticClear" | "SystemClearDriving" | "SystemDiagnosticClearDriving" | "ManualPosition" | "DiagnosticManualPosition" | "MalfunctionManualPosition"

Malfunction or Diagnostic type of the DutyStatusLog.

Defined in

src/types/Checkmate/ObjectModel/DutyStatusMalfunctionTypes.ts:6


DutyStatusOrigin

Ƭ DutyStatusOrigin: "Automatic" | "Manual" | "OtherUser" | "Unassigned"

The origin of a DutyStatusLog.

Defined in

src/types/Checkmate/ObjectModel/DutyStatusOrigin.ts:8


DutyStatusState

Ƭ DutyStatusState: "Active" | "Inactive" | "Requested" | "Rejected"

The state of the DutyStatusLog record.

Defined in

src/types/Checkmate/ObjectModel/DutyStatusState.ts:8


DutyStatusViolationType

Ƭ DutyStatusViolationType: "Driving" | "Rest" | "Duty" | "Workday" | "Cycle" | "DailyDriving" | "DailyRest" | "DailyDuty" | "DailyOff" | "CycleRest" | "DutySinceCycleRest" | "EwdRest" | "EwdWork" | "EwdWorkExemption"

The different types of DutyStatusViolation.

Defined in

src/types/Checkmate/ObjectModel/DutyStatusViolationType.ts:8


EldResponseStatus

Ƭ EldResponseStatus: "Success" | "Error" | "Warning" | "Information" | "NotValidated" | "InvalidRegistrationData" | "EldDecertified" | "Timeout"

Different types of responses that can come from EldPingResponse, EldSubmitResponse and EldError.ErrorType in the response.

Defined in

src/types/Checkmate/Web/EldResponseStatus.ts:6


EldTransferMode

Ƭ EldTransferMode: "None" | "Email" | "WebServices" | "Ping" | "CanadaEmail"

The type of EldTransferMode.

Deprecated

Defined in

src/types/Checkmate/ObjectModel/EldTransferMode.ts:10


EldValidationEntityType

Ƭ EldValidationEntityType: "None" | "Vehicle" | "Driver"

ELD output validation message types.

Defined in

src/types/Checkmate/Web/EldValidationEntityType.ts:6


EldValidationType

Ƭ EldValidationType: "None" | "IncorrectFileDataCheckValue" | "IncorrectLineDataCheckValue" | "IncorrectNumberOfLineValues" | "InvalidCharacter" | "UnexpectedLine" | "MissingFileSection" | "MissingCmv" | "MissingEldUser" | "MissingFileLine" | "DuplicateFileSection" | "MissingRequiredField" | "InvalidFieldLength" | "FieldValueOutsideValidRange" | "InvalidFieldFormat" | "InvalidValue" | "InvalidDecimal" | "InvalidInteger" | "InvalidDate" | "InvalidTime" | "InvalidVin" | "InvalidHexValue" | "UnexpectedEmptyLine" | "InvalidLineDelimiter" | "UnexpectedQuoteDelimiters" | "NoLines" | "EmptyFile" | "InvalidCoordinateValue" | "InvalidEldRegistrationInformation" | "EldRevoked" | "CertificateExpired" | "ParameterMismatch" | "TestInformation" | "UnableToVerifySmimeSignature" | "UnableToDecryptSmimeMessage" | "InvalidMessageSubject" | "MultipleAttachments" | "NoAttachment"

ELD output validation message types.

Defined in

src/types/Checkmate/Web/EldValidationType.ts:6


ElectricEnergyEconomyUnit

Ƭ ElectricEnergyEconomyUnit: "LitersEPer100Km" | "KmPerLitersE" | "KiloWhPer100Km" | "WhPerKm" | "KmPerKiloWh" | "MPGEUS" | "MPGEImperial" | "KiloWhPer100Miles" | "WhPerMile" | "MilePerKiloWh" | "KiloWhPerKm" | "KiloWhPerMile"

Various Electric Energy Economy units Geotab supports. Currently supported units: L-e/100 km, km/L-e, kWh/100 km, Wh/km, km/kWh, MPG-e (US), MPG-e (Imp), kWh/100 miles, Wh/mile and mile/kWh.

Defined in

src/types/Checkmate/Settings/ElectricEnergyEconomyUnit.ts:8


ElectricEnergyUnit

Ƭ ElectricEnergyUnit: "LitersE" | "GallonUSE" | "GallonImpE" | "KilowattHour" | "WattHour"

Various supported Electric Energy units Geotab supports.

Defined in

src/types/Checkmate/Settings/ElectricEnergyUnit.ts:8


EncryptionType

Ƭ EncryptionType: "NoEncryption" | "AES256CredentialsKey" | "AES256VaultKey"

The type of encryption.

Defined in

src/types/Checkmate/ObjectModel/EncryptionType.ts:6


EntityBackfillStatus

Ƭ EntityBackfillStatus: "Unknown" | "Initialising" | "Running" | "Stopped"

Options for entity backfill status

Defined in

src/types/Checkmate/ObjectModel/EntityBackfillStatus.ts:6


EntityLinkType

Ƭ EntityLinkType: "Device" | "DeviceDriver" | "DeviceCoDriver" | "DevicePassenger" | "TachographCoDriver"

The type of EntityLinkType.

Defined in

src/types/Checkmate/ObjectModel/EntityLink/EntityLinkType.ts:6


EntitySelectionType

Ƭ EntitySelectionType: "None" | "Device" | "Driver" | "ExceptionRule" | "Zone" | "Mechanic" | "User" | "Route"

The type of an Entity.

Deprecated

Defined in

src/types/Checkmate/Settings/EntitySelectionType.ts:11


EntityType

Ƭ EntityType: "Device" | "User" | "TachographCompanyCard" | "Global"

Represents the type of entity a EntitySetting is linked to.

Defined in

src/types/Checkmate/ObjectModel/EntitySettings/EntityType.ts:6


EntityTypes

Ƭ EntityTypes: Object

Type declaration

Name Type
AddIn AddIn
AddInData AddInData
AnnotationLog AnnotationLog
Audit Audit
BackfillStatus BackfillStatus
BinaryData BinaryData
Certificate Certificate
ChargeEvent ChargeEvent
Controller Controller
CustomData CustomData
DVIRDefect DVIRDefect
DVIRLog DVIRLog
Dashboard Dashboard
DebugData DebugData
Defect Defect
DefectRemark DefectRemark
Device Device
DeviceLink DeviceLink
DeviceMasterFlag DeviceMasterFlag
DeviceRegistrationState DeviceRegistrationState
DeviceReplacementInfo DeviceReplacementInfo
DeviceReprocessRequest DeviceReprocessRequest
DeviceShare DeviceShare
DeviceStatusInfo DeviceStatusInfo
Diagnostic Diagnostic
DiagnosticMapping DiagnosticMapping
DisplayMeasurementProfile DisplayMeasurementProfile
DisplayMeasurementProfileDetail DisplayMeasurementProfileDetail
DisplayUnitOfMeasure DisplayUnitOfMeasure
DistributionList DistributionList
DriverChange DriverChange
DriverRegulation DriverRegulation
DutyStatusAvailability DutyStatusAvailability
DutyStatusLog DutyStatusLog
DutyStatusViolation DutyStatusViolation
EmployeeRoutePlan EmployeeRoutePlan
EnergySnapshotRecord EnergySnapshotRecord
EngineType EngineType
EntityLinkRule EntityLinkRule
EntitySetting EntitySetting
EventDeviation EventDeviation
EventOccurrence EventOccurrence
EventOccurrenceDue EventOccurrenceDue
EventRule EventRule
ExceptionEvent ExceptionEvent
ExceptionEventAttachment ExceptionEventAttachment
ExceptionEventComment ExceptionEventComment
FailureMode FailureMode
FaultData FaultData
FeedVersionTrackingData FeedVersionTrackingData
FillUp FillUp
FuelSnapshotRecord FuelSnapshotRecord
FuelTaxDetail FuelTaxDetail
FuelTransaction FuelTransaction
FuelUpEvent FuelUpEvent
FuelUsed FuelUsed
Group Group
GroupDevice GroupDevice
GroupFilter GroupFilter
GroupZoneMetadata GroupZoneMetadata
HosRulesetConfig HosRulesetConfig
InstallRecord InstallRecord
IoxAddOn IoxAddOn
IoxAddOnStatus IoxAddOnStatus
LiveCompletionMapConfig LiveCompletionMapConfig
LogRecord LogRecord
LogRecordZoneDistance LogRecordZoneDistance
MaintenanceNotificationRule MaintenanceNotificationRule
MaintenanceNotificationState MaintenanceNotificationState
MediaFile MediaFile
MimeTask MimeTask
Notification Notification
ParameterGroup ParameterGroup
Property Property
PropertySet PropertySet
Recipient Recipient
ReportStorage ReportStorage
ReportTemplate ReportTemplate
RestrictedDataModeChange RestrictedDataModeChange
Route Route
RouteExtract RouteExtract
Rule Rule
SecurityId SecurityId
ServiceState ServiceState
ShareableLink ShareableLink
ShipmentLog ShipmentLog
Source Source
StatusData StatusData
TachographActivitiesCertificate TachographActivitiesCertificate
TachographCompanyCard TachographCompanyCard
TachographDataFile TachographDataFile
TachographVehicleInspection TachographVehicleInspection
TextMessage TextMessage
Trailer Trailer
TrailerAttachment TrailerAttachment
Trip Trip
TripAnnotation TripAnnotation
TripGeohash TripGeohash
TripTypeChange TripTypeChange
UnitOfMeasure UnitOfMeasure
User User
UserDeviceLink UserDeviceLink
UserDisplayProfile UserDisplayProfile
UserHosRuleSet UserHosRuleSet
UserLoginStatus UserLoginStatus
UserSupport UserSupport
VirtualExceptionEvent VirtualExceptionEvent
Widget Widget
WifiHotspot WifiHotspot
WorkHoliday WorkHoliday
WorkTime WorkTime
Zone Zone
ZoneType ZoneType

Defined in

src/types/EntityTypes.ts:115


Error

Ƭ Error: "None" | "Unauthorized" | "DbUnavailable"

Defines the result of process locking for ServiceLock.

Deprecated

Defined in

src/types/Checkmate/ObjectModel/Lock/Error.ts:10


EulaAcceptanceLevel

Ƭ EulaAcceptanceLevel: "CompanyWide"

Indicates which level a EULA should be accepted at (e.g. once-per-company, once-per-user).

Defined in

src/types/Checkmate/ObjectModel/EulaAcceptanceLevel.ts:6


ExceptionInfoTag

Ƭ ExceptionInfoTag: "Database" | "Source" | "Area" | "SeverityLevel" | "Description" | "Warning" | "UserName"

The currently supported exception info tag key.

Defined in

src/types/Checkmate/ExceptionInfoTag.ts:6


ExceptionRuleBaseType

Ƭ ExceptionRuleBaseType: "Custom" | "RouteDefinition" | "Stock" | "ZoneStop" | "RouteCompletion" | "RouteBasedMaterialMgmt" | "Virtual" | "Unknown"

When exceptions are created based on built-in rules, the base type is always set to "Stock". For rules which are defined by you, the base type will be "Custom". The ZoneStop base type is used to designate exceptions created specifically when a zone is configured with the "MustIdentifyStops" property set to true.

Defined in

src/types/Checkmate/ObjectModel/Exceptions/ExceptionRuleBaseType.ts:10


ExceptionRuleCategory

Ƭ ExceptionRuleCategory: "ApplicationExceptionRule" | "UserExceptionRules" | "ZoneStopExceptionRules"

Specific categories to which the exception rules belong.

Defined in

src/types/Checkmate/ObjectModel/Exceptions/ExceptionRuleCategory.ts:6


ExceptionRuleMode

Ƭ ExceptionRuleMode: "Inside" | "Outside" | "StopInside" | "StopOutside" | "EnteringZone" | "ExitingZone"

The mode of the Rule.

Defined in

src/types/Checkmate/ObjectModel/Exceptions/ExceptionRuleMode.ts:6


ExceptionRuleType

Ƭ ExceptionRuleType: "Normal" | "System" | "Zone" | "ApplicationException" | "None"

This enumerated type allows designating rules to be of a certain type to assist with differentiating them from one another.

Defined in

src/types/Checkmate/ObjectModel/Exceptions/ExceptionRuleType.ts:9


FaultLampState

Ƭ FaultLampState: "None" | "Malfunction" | "Warning" | "Stop" | "Protect"

Represents the lamp status of a J1939 fault, see FaultData.

Defined in

src/types/Checkmate/ObjectModel/Engine/FaultLampState.ts:6


FaultResetMode

Ƭ FaultResetMode: "None" | "AutoReset"

Specify whether the fault resets automatically or manually.

Defined in

src/types/Checkmate/ObjectModel/Engine/FaultResetMode.ts:6


FaultState

Ƭ FaultState: "None" | "Pending" | "Active" | "Inactive" | "Cleared"

Represents a fault code state code from the engine system of the specific Device. This properties using this enum will be deprecated in the near future and replaced by a property of the FaultStatus type.

Defined in

src/types/Checkmate/ObjectModel/Engine/FaultState.ts:6


FilterComparison

Ƭ FilterComparison: "LessThan" | "GreaterThan" | "EqualTo" | "IsNull" | "IsNotNull" | "LessThanOrEqualTo" | "GreaterThanOrEqualTo"

Filter comparison type.

Defined in

src/types/Checkmate/ObjectModel/FilterComparison.ts:6


FilterType

Ƭ FilterType: "Devices" | "Groups" | "DeviceSearch"

Specifies a type of filter.

Defined in

src/types/Checkmate/ObjectModel/Reprocessing/FilterType.ts:6


FirmwareType

Ƭ FirmwareType: "EthernetRadioDownloader" | "UsbRadioDownloader"

The type of firmware.

Defined in

src/types/Checkmate/ObjectModel/FirmwareType.ts:6


FuelEconomyUnit

Ƭ FuelEconomyUnit: "LitersPer100Km" | "KmPerLiter" | "MPGUS" | "MPGImperial" | "KmPerGallon" | "GallonPer100Km"

Various Fuel Economy units Geotab supports. Currently supported units: L/100 km, km/L, MPG (US) and MPG (Imperial).

Defined in

src/types/Checkmate/Settings/FuelEconomyUnit.ts:8


FuelTankCapacitySource

Ƭ FuelTankCapacitySource: "Unknown" | "DiagnosticTankCapacity" | "EstimateFuelLevel" | "EstimateFuelUnits" | "DeviceTankCapacity"

The source from which tank capacity was derived.

Defined in

src/types/Checkmate/ObjectModel/Fuel/FuelTankCapacitySource.ts:6


FuelTaxRoadType

Ƭ FuelTaxRoadType: "Unknown" | "OffRoad" | "Public" | "Private" | "Toll" | "Rail"

Fuel tax road type.

Defined in

src/types/Checkmate/ObjectModel/FuelTaxRoadType.ts:6


FuelTransactionProductType

Ƭ FuelTransactionProductType: "Unknown" | "NonFuel" | "Regular" | "Midgrade" | "Premium" | "Super" | "Diesel" | "E85" | "CNG" | "LPG" | "Hydrogen" | "DieselExhaustFluid" | "Electric"

Represents the type of product purchased in a FuelTransaction.

Defined in

src/types/Checkmate/ObjectModel/Fuel/FuelTransactionProductType.ts:6


FuelTransactionProvider

Ƭ FuelTransactionProvider: "Unknown" | "WexLegacy" | "WexCustomer" | "Drive" | "FuelTracker" | "Comdata" | "Fuelman" | "Wex" | "Voyager" | "UltramarCST" | "GFN" | "WexCanada" | "Allstar" | "Keyfuels" | "TFC"

FuelTransaction data providers.

Defined in

src/types/Checkmate/ObjectModel/Fuel/FuelTransactionProvider.ts:6


FuelUpEventConfidences

Ƭ FuelUpEventConfidences: "None" | "FuelLevel" | "TripStop" | "FuelTransaction" | "DeviceMatchedFuelTransaction" | "LocationMatchedFuelTransaction" | "TripStopFuelTransaction" | "DeviceFuelLevelMatchedFuelTransaction" | "LocationFuelLevelMatchedFuelTransaction" | "NotCommunicating" | "FuelLevelIndeterminate" | "DriverMatchedFuelTransaction" | "FuelUsedInconsistent" | "EngineElectricEnergy"

Confidence of the fuel event data, derived from how many data points successfully matched to calculate a FuelUpEvent.

Defined in

src/types/Checkmate/ObjectModel/Fuel/FuelUpEventConfidences.ts:9


GoTalkLanguage

Ƭ GoTalkLanguage: "English" | "French" | "Spanish" | "German" | "Italian"

The language used by a GoTalk attached to a. GoDevice

Defined in

src/types/Checkmate/ObjectModel/GoTalkLanguage.ts:6


GoogleMapStyle

Ƭ GoogleMapStyle: "Roadmap" | "Hybrid" | "Terrain" | "Satellite"

Used to represent different Google Map styles.

Defined in

src/types/Checkmate/Settings/GoogleMapStyle.ts:6


GroupZoneMetadataType

Ƭ GroupZoneMetadataType: "None" | "ExpectedPassCount"

Defines the different types of GroupZoneMetadata(s).

Defined in

src/types/Checkmate/ObjectModel/GroupZoneMetadataType.ts:6


HereMapStyle

Ƭ HereMapStyle: "None" | "Roadmap" | "Satellite" | "Terrain"

Here Map Style.

Defined in

src/types/Checkmate/Settings/HereMapStyle.ts:6


HosOption

Ƭ HosOption: "OFF" | "ON" | "AUTO"

The HOS log generation options.

Defined in

src/types/Checkmate/ObjectModel/HosOption.ts:6


HosRuleSet

Ƭ HosRuleSet: "None" | "NoneCanada" | "America7Day" | "America7DaySleeper" | "America7DayBig" | "America7DayBigSleeper" | "America8Day" | "America8DaySleeper" | "America8DayBig" | "America8DayBigSleeper" | "America7DayPassenger" | "America8DayPassenger" | "AmericaShortHaul" | "AmericaShortHaul8Day" | "AmericaShortHaul14hrWorkday" | "AmericaShortHaul8Day14hrWorkday" | "AmericaShortHaulPassenger" | "AmericaShortHaulPassenger8Day" | "CanadaCycleOne" | "CanadaCycleTwo" | "CaliforniaProperty" | "CaliforniaFlammableLiquid" | "CaliforniaFlammableLiquidWithRestRequirement" | "CaliforniaSchoolPupil" | "CaliforniaSchoolPupilWithRestRequirement" | "CaliforniaFarmProduct" | "CaliforniaFarmProductWithRestRequirement" | "CaliforniaPassenger" | "OilTransport7Day" | "OilTransport7DaySleeper" | "OilTransport7DayBig" | "OilTransport7DayBigSleeper" | "OilTransport8Day" | "OilTransport8DaySleeper" | "OilTransport8DayBig" | "OilTransport8DayBigSleeper" | "OilTransportShortHaul" | "OilTransportShortHaul8Day" | "OilTransportShortHaul14hrWorkday" | "OilTransportShortHaul8Day14hrWorkday" | "OilTransportCalifornia8day" | "OilWellCalifornia8day" | "OilTransportCaliforniaProperty" | "OilWellCaliforniaProperty" | "OilWell7Day" | "OilWell7DaySleeper" | "OilWell7DayBig" | "OilWell7DayBigSleeper" | "OilWell8Day" | "OilWell8DaySleeper" | "OilWell8DayBig" | "OilWell8DayBigSleeper" | "AmericaSalesperson" | "AmericaSalespersonNonCdlShortHaul" | "AmericaTexas" | "AmericaTexasShortHaul" | "AmericaTexasShortHaul8Day" | "OilTransportTexas" | "OilWellTexas" | "Florida7Day" | "Florida8Day" | "FloridaShortHaul7Day" | "FloridaShortHaul8Day" | "America7DayNo34h" | "America7DayNo34hSleeper" | "America8DayNo34h" | "America8DayNo34hSleeper" | "AmericaShortHaulNo34h" | "AmericaShortHaul8DayNo34h" | "BrazilShortHaul" | "CarrierExemption" | "AmericaNonCdlShortHaul7Day" | "AmericaNonCdlShortHaul8Day" | "WashingtonIntrastate7Day" | "WashingtonIntrastate8Day" | "AmericaNoRestRequirement7Day" | "AmericaNoRestRequirement7DaySleeper" | "AmericaNoRestRequirement7DayBig" | "AmericaNoRestRequirement7DayBigSleeper" | "AmericaNoRestRequirement8Day" | "AmericaNoRestRequirement8DaySleeper" | "AmericaNoRestRequirement8DayBig" | "AmericaNoRestRequirement8DayBigSleeper" | "OilTransportNoRestRequirement7Day" | "OilTransportNoRestRequirement7DaySleeper" | "OilTransportNoRestRequirement7DayBig" | "OilTransportNoRestRequirement7DayBigSleeper" | "OilTransportNoRestRequirement8Day" | "OilTransportNoRestRequirement8DaySleeper" | "OilTransportNoRestRequirement8DayBig" | "OilTransportNoRestRequirement8DayBigSleeper" | "OilWellNoRestRequirement7Day" | "OilWellNoRestRequirement7DaySleeper" | "OilWellNoRestRequirement7DayBig" | "OilWellNoRestRequirement7DayBigSleeper" | "OilWellNoRestRequirement8Day" | "OilWellNoRestRequirement8DaySleeper" | "OilWellNoRestRequirement8DayBig" | "OilWellNoRestRequirement8DayBigSleeper" | "NorthDakota7Day" | "SouthCarolina7Day" | "SouthCarolina8Day" | "MarylandShortHaul7Day" | "MarylandShortHaul8Day" | "NorthDakotaShortHaul7Day" | "AlaskaPassenger7Day" | "AlaskaPassenger8Day" | "AlaskaProperty7Day" | "AlaskaProperty7DaySleeper" | "AlaskaProperty8Day" | "AlaskaProperty8DaySleeper" | "Nebraska7day" | "Nebraska8day" | "California8day" | "Oregon7day" | "Oregon8day" | "None8Day" | "CanadaCycleOneTeam" | "CanadaCycleTwoTeam" | "CanadaNorthOf60CycleOne" | "CanadaNorthOf60CycleTwo" | "CanadaNorthOf60CycleOneTeam" | "CanadaNorthOf60CycleTwoTeam" | "NoneCanadaNorthOf60" | "AustraliaStandardHoursSoloExemptionHours" | "CaliforniaPropertyShortHaul" | "CaliforniaPropertyShortHaulWithRest" | "CanadaOil" | "CanadaNorthOf60Oil" | "CanadaOilTeam" | "CanadaNorthOf60OilTeam" | "America7DayRailroad" | "America8DayRailroad"

HOS rulesets for the User.

Defined in

src/types/Checkmate/Settings/HosRuleSet.ts:6


ImportTaskStatus

Ƭ ImportTaskStatus: "Ready" | "Processing" | "Completed" | "Failed"

The processing status of the Import Task.

Defined in

src/types/Checkmate/ObjectModel/Import/ImportTaskStatus.ts:6


ImportTaskType

Ƭ ImportTaskType: "RouteCompletion"

The type of the Import Task.

Defined in

src/types/Checkmate/ObjectModel/Import/ImportTaskType.ts:6


IncludeGroups

Ƭ IncludeGroups: "Child" | "Parent" | "ParentAndChild" | "Direct"

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.

Defined in

src/types/Checkmate/ObjectModel/IncludeGroups.ts:6


InstallStatus

Ƭ InstallStatus: "NotAccepted" | "Accepted" | "Rejected" | "ObsoleteDevice"

Status of the installation for the device. User can choose to accept or ignore the latest installation records from UI.

Defined in

src/types/Checkmate/ObjectModel/InstallRecords/InstallStatus.ts:6


InstallationType

Ƭ InstallationType: "Unknown" | "NewInstallation" | "SwapDevices" | "ServiceDevice" | "RemoveDevice"

Installation type for the device. - e.g. "New Installation" in case of first time install.

Defined in

src/types/Checkmate/ObjectModel/InstallRecords/InstallationType.ts:6


InvalidGroupFilterType

Ƭ InvalidGroupFilterType: "ToManyEvaluations"

An enum representing invalid group filter exception types.

Defined in

src/types/Checkmate/ObjectModel/InvalidGroupFilterType.ts:6


InvalidUserType

Ƭ InvalidUserType: "Default" | "SessionExpired" | "UserLockout" | "SessionInvalid" | "UserArchived" | "UserSuspended" | "RefreshTokenExpired" | "RefreshTokenUsed" | "RefreshTokenDoesNotExist"

An enum representing invalid user exception types.

Defined in

src/types/Checkmate/ObjectModel/InvalidUserType.ts:6


Iso8601Resolution

Ƭ Iso8601Resolution: "Millisecond" | "Full"

An enum specifying to what resolution to serialize a DateTime to in the ISO 8601 format.

Defined in

src/types/Serialization/Iso8601Resolution.ts:6


JsonRpcErrorCode

Ƭ JsonRpcErrorCode: "None" | "ParseError" | "InternalError" | "InvalidParams" | "MethodNotFound" | "InvalidRequest" | "GroupRelationViolatedError" | "DbUnavailableGeneralError" | "DbUnavailableConnectionFailure" | "DbUnavailableUnknownDatabase" | "DbUnavailableInitializing" | "DbUnavailableOperationAborted" | "InvalidCertificateException" | "InternalServerError"

Indicates the JSON-RPC error type that occurred. Derived from JSON-RPC 2.0 specification.

Defined in

src/types/Checkmate/ObjectModel/Web/JsonRpcErrorCode.ts:6


Jurisdiction

Ƭ Jurisdiction: "None" | "NoJurisdiction" | "AU" | "BR" | "CA" | "US" | "AS" | "EU" | "USGov"

Mapping of jurisdiction regions.

Defined in

src/types/Checkmate/ObjectModel/Jurisdictional/Jurisdiction.ts:6


KeyType

Ƭ KeyType: "Unknown" | "DriverId" | "DriverIdAndData" | "AccidentData" | "LoggingParameters" | "GoFirmware" | "ToggleDebug" | "ResetPointers" | "ResetProductId" | "LatestTripData" | "ToggleRFPing" | "GSMParameters" | "ToggleJ1708Ignition" | "Go3Firmware" | "WifiParameters" | "WiFiSecurity" | "Go5Firmware" | "WifiLive" | "DevicePowerUpReset" | "IgnitionTimeout" | "NFCDriverId" | "NFCCdmaReset" | "NFCDebugMode" | "NFCPassengerId" | "GenericNFCDriverId" | "CustomNFCDriverId" | "TachographDriverId" | "TachographCoDriverId" | "CustomDriverId"

Supported Legacy Key Types.

Deprecated

Defined in

src/types/Checkmate/ObjectModel/KeyType.ts:10


LimitSource

Ƭ LimitSource: "None" | "Apiv1"

Sources for which a limit should be applied.

Defined in

src/types/Checkmate/ObjectModel/Limits/LimitSource.ts:6


LogReason

Ƭ LogReason: "CustomDataOrUnknown" | "Accident" | "Heading" | "Speed" | "Time" | "Aux" | "Ignition" | "Reset" | "Next" | "All" | "Antenna" | "SpeedingStart" | "SpeedingStop" | "GpsShutdown" | "HotStartStart" | "HotStartValidSignal" | "HotStartNoValidSignal" | "InvalidGpsSignals" | "GpsQuiet" | "BrownOut" | "HarshBraking" | "BeginOfStop" | "EndOfStop" | "SystemReset" | "ConnectedToServer" | "ConnectionFailure" | "DeviceUnplugged" | "CurveBased" | "CurveSpeed" | "MultiplexRequestGPS" | "MultiplexConnectedGPS" | "MultiplexRequestRF" | "MultiplexConnectedRF" | "RestartGPS" | "RestartRF" | "CurvePositionEstimateError" | "CurveTimeOut" | "CurveOtherEvent" | "CurveZeroSpeed" | "CurveTimeChange" | "RfUploadComplete" | "DevicePoll" | "CurveSpeedEstimateError" | "WifiInRange" | "WifiConnected" | "WifiUploadSuccess" | "IridiumIgnition" | "IridiumAux" | "IridiumTime" | "IridiumPoll" | "IridiumEmergency" | "IridiumLowVoltage" | "IridiumAccelEvent" | "IridiumMovementDetected" | "IridiumOutOfCoverage" | "IridiumPowerUp" | "IridiumDriverChange" | "J1708ICPError" | "ErrorRestartGPSStateMachine" | "ErrorRebootSlave" | "ErrorRestartRfStateMachine" | "ErrorRestartRfManagerStateMachine" | "ErrorRestartWifiStateMachine" | "ErrorRestartWifiManagerStateMachine" | "ErrorRestartModemStateMachine" | "ErrorRestartModemManagerStateMachine" | "SoftwareInsertedLog" | "ErrorClockStopped" | "ErrorReadingFlash" | "InvalidStackPointer" | "ErrorInterruptError" | "EventPlaceholder"

GPSData and DebugData Log Reason codes.

Defined in

src/types/Checkmate/ObjectModel/LogReason.ts:6


LoginRedirectTarget

Ƭ LoginRedirectTarget: "Manage" | "Drive" | "DriveCoDriver"

Target app for SSO authentication redirect.

Deprecated

Defined in

src/types/Checkmate/ObjectModel/LoginRedirectTarget.ts:10


MediaFileType

Ƭ MediaFileType: "Wav" | "NotificationEmailTemplate" | "WebRequestTemplate" | "TextTemplate"

The type of the media file.

Defined in

src/types/Checkmate/ObjectModel/MediaFileType.ts:6


MediaType

Ƭ MediaType: "Unknown" | "Video" | "Image" | "Application" | "BinaryData"

The type of a MediaFile.

Defined in

src/types/Checkmate/ObjectModel/Files/MediaType.ts:6


MessageContentType

Ƭ MessageContentType: "Normal" | "CannedResponse" | "Location" | "DataToComponent" | "StatusDataRequest" | "Immobilization" | "GoTalk" | "IoxOutput" | "Beep" | "SerialIox" | "DriverAuthList" | "MimeContent" | "CAN" | "PassthroughEnabledMessage" | "VehicleCommand" | "OtauContent" | "WorkshopMode" | "FlashMemory" | "MimeReferenceContent"

The type of TextMessage content.

Defined in

src/types/Checkmate/ObjectModel/MessageContentType.ts:6


Middleware

Ƭ Middleware: (next: Next) => Next

Type declaration

▸ (next): Next

A function that returns a middleware function.

Parameters
Name Type Description
next Next The next Next in the chain.
Returns

Next

Defined in

src/types/Middleware.ts:8


MonitorPredicate

Ƭ MonitorPredicate: "None" | "Start" | "End" | "Avg" | "Min" | "Max" | "LowerEdge" | "UpperEdge" | "Longitude" | "Latitude"

Defines the different types of rule monitor predicates.

Defined in

src/types/Checkmate/ObjectModel/Exceptions/MonitorPredicate.ts:6


Next

Ƭ Next: (call: Call) => Promise<unknown>

Type declaration

▸ (call): Promise<unknown>

A function that executes the given JSON-RPC call and returns the call results.

Parameters
Name Type
call Call
Returns

Promise<unknown>

Defined in

src/types/Middleware.ts:11


NotificationBinaryFileType

Ƭ NotificationBinaryFileType: "None" | "AudioAlarmFile" | "EmailTemplate" | "WebRequestTemplate" | "TextTemplate"

The type of the data stored in NotificationBinary.

Defined in

src/types/Checkmate/ObjectModel/NotificationBinaryFileType.ts:6


NotificationStatus

Ƭ NotificationStatus: "StatusUnknown" | "StatusDisabled" | "StatusDisconnected" | "StatusConnected" | "StatusDebug" | "StatusIdle" | "StatusStopped" | "StatusUnlocked" | "StatusRunningNoAidingDataAvailable" | "StatusRunning" | "StatusFTDINotInstalled" | "StatusTryingToLock" | "StatusAuthenticationFailed" | "StatusAuthenticationNotSupported" | "StatusAuthenticationSchemeNotProvided" | "StatusUnknownResponseFromServer" | "StatusServerNotFound" | "StatusProxyServerNotFound" | "StatusTimeout" | "StatusProxyTimeout" | "StatusDeviceRegistrationFailed" | "StatusConnecting" | "UpdateMessageCountsFailed" | "InvalidOrbcommCustomer" | "ThreadFinishTimeout" | "StatusWaitingForUpgrade" | "StatusUserCleared" | "StatusMissing" | "StatusServiceManagerConnected" | "CacheCleared" | "CacheBusy" | "StatusExceptionOccurred" | "StatusDeviceDeleted" | "StatusDelayed"

The status of the notification.

Defined in

src/types/Checkmate/ObjectModel/NotificationStatus.ts:6


NotificationTemplatePurpose

Ƭ NotificationTemplatePurpose: "ExceptionEvent" | "MaintenanceNotification"

The purpose of a notification template

Defined in

src/types/Checkmate/ObjectModel/NotificationTemplatePurpose.ts:6


NotificationTokenType

Ƭ NotificationTokenType: "Address" | "Database" | "Date" | "Device" | "DeviceComments" | "DeviceGroups" | "DeviceId" | "DeviceWithDriverName" | "Diagnostic" | "DiagnosticCode" | "DriverComment" | "DriverName" | "DriverFirstName" | "DriverGroups" | "DriverLastName" | "DVIRDefect" | "Latitude" | "Longitude" | "Map" | "Odometer" | "Rule" | "SerialNumber" | "Speed" | "SpeedLimit" | "Time" | "Timezone" | "Vin" | "Zone" | "ZoneComment" | "ZoneId"

Current available tokens to use in templates such as email template

Defined in

src/types/Checkmate/ObjectModel/NotificationTokenType.ts:6


NotificationType

Ƭ NotificationType: "Info" | "ApplicationException" | "Exception" | "News" | "ExceptionToBeProcessed" | "ApplicationExceptionForUsers" | "MessageForUser" | "UserModified" | "ApplicationNotificationForAdmins" | "MaintenanceNotification" | "DeviceShareNotification" | "Report"

The type of Notification.

Defined in

src/types/Checkmate/ObjectModel/NotificationType.ts:6


OpenStreetMapStyle

Ƭ OpenStreetMapStyle: "None" | "MapBox" | "Cycle" | "Transport" | "Satellite"

Used to represent different Open Street Map (OSM) styles.

Defined in

src/types/Checkmate/Settings/OpenStreetMapStyle.ts:6


PingMessageType

Ƭ PingMessageType: "Unknown" | "Hello" | "KeepAlive" | "Finish" | "Error"

The message type of a ping message.

Deprecated

Defined in

src/types/Checkmate/ObjectModel/Web/PingMessageType.ts:10


PostedRoadSpeedOptions

Ƭ PostedRoadSpeedOptions: "None" | "NoEstimates" | "NoCommunity" | "NoCommercial"

Defines options for a posted road speed request.

Defined in

src/types/Checkmate/ObjectModel/PostedRoadSpeedOptions.ts:6


ProcessingStatus

Ƭ ProcessingStatus: "DaylightHoursProcessing" | "AfterHoursProcessing" | "DaylightHoursReprocessing" | "AfterHoursReprocessing" | "Idle" | "Unavailable"

An enum that indicates the uploader status.

Defined in

src/types/Checkmate/ObjectModel/Web/ProcessingStatus.ts:6


PubSubDataUpdateVerb

Ƭ PubSubDataUpdateVerb: "Add" | "Set" | "Remove"

Indicates the type of operation delivered by PubSubDataUpdateData`1.

Defined in

src/types/Checkmate/ObjectModel/PubSub/PubSubDataUpdateVerb.ts:6


RecipientType

Ƭ RecipientType: "LogOnly" | "Email" | "LogPopup" | "LogUrgentPopup" | "Alarm" | "WebService" | "TextMessage" | "ChangeStatus" | "BeepThreeTimesRapidly" | "BeepThreeTimes" | "BeepTenTimesRapidly" | "LogPopupInfo" | "WebRequest" | "AssignToGroup" | "TextToSpeech" | "LogNewsPopup" | "BeepThreeTimesRapidlyAllowDelay" | "BeepThreeTimesAllowDelay" | "BeepTenTimesRapidlyAllowDelay" | "TextToSpeechAllowDelay" | "TripTypeChange" | "EmailToGroup" | "HosEnabled" | "HosDisabled" | "RestrictedDataMode" | "ExpireShareableLink" | "DeviceShareFailure"

The type of notification message that is generated for a Recipient.

Defined in

src/types/Checkmate/ObjectModel/RecipientType.ts:6


RegistrationStatus

Ƭ RegistrationStatus: "None" | "Registered" | "FailedRegistration" | "Unregistered" | "FailedUnregistration" | "ReconciledAsRegistered" | "ReconciledAsUnregistered"

Enum denoting registration states between MyG and the Gateway.

Defined in

src/types/Checkmate/ObjectModel/Registration/Gateway/RegistrationStatus.ts:6


RelayState

Ƭ RelayState: "Off" | "On" | "DriverKey"

Enum for the possible relay states.

Defined in

src/types/Checkmate/ObjectModel/RelayState.ts:6


RepairStatusType

Ƭ RepairStatusType: "NotRepaired" | "Repaired" | "NotNecessary"

The Repair Status for DVIRDefect.

Defined in

src/types/Checkmate/ObjectModel/RepairStatusType.ts:8


ReplacementType

Ƭ ReplacementType: "Unknown" | "Sunset"

Replacement type for the device.

Defined in

src/types/Checkmate/ObjectModel/DeviceReplacement/ReplacementType.ts:6


ReportArgumentType

Ƭ ReportArgumentType: "DebugReport" | "DeviceActivityDetail" | "DriverActivityDetail" | "RouteActivityDetail" | "DeviceActivitySummary" | "DriverActivitySummary" | "RouteActivitySummary" | "ExceptionsByDevice" | "ExceptionsByDriver" | "ExceptionsSummaryGraph" | "RiskManagement" | "AuditLog" | "UserList" | "DiagnosticList" | "Congregation" | "Reminder" | "EventRules" | "RouteSummaryReport" | "UnassignedRouteReport" | "FuelTaxDeviceReport" | "FuelTaxDriverReport" | "EngineStatusSummary" | "EngineStatusFault" | "EngineStatusStatus" | "TimeCardCalculator" | "ZoneList" | "DeviceReportCalculator" | "EventOccurrences" | "Notifications" | "GroupCalculator" | "DeviceInstallHistory" | "RouteDirection" | "EngineStatusStatistics" | "TextMessages" | "RouteComparisonDetailReport" | "HosLog" | "HosViolation" | "HosAvailability" | "DVIRLogs" | "TripsIdlingSummaryGraph" | "TripsDensitySummaryGraph" | "FleetSummaryGraph" | "CustomerStopGraph" | "FillUps" | "ChargeEvent" | "MaterialManagement" | "RouteCompletion" | "EVBatteryHealth" | "DummyReportCalculator"

Enum to specify the type of the argument.

Defined in

src/types/Checkmate/ObjectModel/ReportArgumentType.ts:6


ReportDataSource

Ƭ ReportDataSource: "TripsDetail" | "RiskManagement" | "ExceptionsDetail" | "Debug" | "ExceptionsSummary" | "TripsSummary" | "TimeCard" | "AuditLog" | "UserList" | "DiagnosticList" | "ZoneVisitsDetail" | "ZoneVisitsSummary" | "RouteSummary" | "UnassignedRoute" | "Notification" | "FuelTax" | "ZoneList" | "Congregation" | "EngineSummary" | "EngineFault" | "EngineStatus" | "Device" | "RouteDirections" | "Reminder" | "EventRuleDevice" | "EventHistory" | "GroupsList" | "DeviceInstallHistory" | "EngineStatusStatistics" | "TextMessage" | "RouteComparisonDetail" | "HosLog" | "DVIRLog" | "HosViolation" | "ExceptionsSummaryGraph" | "TripsIdlingSummaryGraph" | "FleetSummaryGraph" | "CustomerStopGraph" | "TripsDensitySummaryGraph" | "FillUps" | "HosAvailability" | "ChargeEvent" | "MaterialManagement" | "RouteCompletion" | "EVBatteryHealth"

Used to specify the type of the report template.

Defined in

src/types/Checkmate/ObjectModel/ReportDataSource.ts:6


ReportDestination

Ƭ ReportDestination: "None" | "EmailExcel" | "Dashboard" | "NormalReport" | "EmailPdf" | "InteractiveDashboard"

Used to specify where the destination of the scheduled report.

Defined in

src/types/Checkmate/ObjectModel/ReportDestination.ts:6


ReportFrequency

Ƭ ReportFrequency: "None" | "FiveMinutes" | "ThirtyMinutes" | "Hourly" | "Daily" | "Weekly" | "Monthly" | "WhenNeed" | "Minute" | "BiWeekly" | "FourWeeks" | "Quarterly"

The frequency with which reports can be generated.

Defined in

src/types/Checkmate/ObjectModel/ReportFrequency.ts:6


ReportHeading

Ƭ ReportHeading: "DummyColumnOne" | "DummyColumnTwo" | "DummyColumnThree" | "DummyCustomProperty" | "DummyName" | "DeviceName" | "DeviceId" | "DeviceComment" | "DeviceGroup" | "DeviceParentGroup" | "DriverGroup" | "WorkTimeName" | "TripDetailMaximumSpeed" | "TripDetailStopDuration" | "TripDetailRouteName" | "TripDetailIdlingDuration" | "TripDetailStopDateTime" | "TripDetailStartDateTime" | "TripDetailDrivingDuraion" | "TripDetailDistance" | "TripDetailLatitude" | "TripDetailLongitude" | "TripDetailLocation" | "TripDetailStartLocation" | "TripDetailSpeedRange1" | "TripDetailSpeedRange1Duration" | "TripDetailSpeedRange2" | "TripDetailSpeedRange2Duration" | "TripDetailSpeedRange3" | "TripDetailSpeedRange3Duration" | "TripDetailIsStartDriveWorkHours" | "TripDetailIsStopDriveWorkHours" | "TripDetailWorkHoursDistance" | "TripDetailWorkHoursTripTime" | "TripDetailWorkHoursStopTime" | "TripDetailOdometerAtStart" | "TripDetailOdometerAtEnd" | "TripDetailExceptionRule1Duration" | "TripDetailExceptionRule1Count" | "TripDetailExceptionRule1Distance" | "TripDetailExceptionRule2Duration" | "TripDetailExceptionRule2Count" | "TripDetailExceptionRule2Distance" | "TripDetailExceptionRule3Duration" | "TripDetailExceptionRule3Count" | "TripDetailExceptionRule3Distance" | "TripDetailExceptionRule4Duration" | "TripDetailExceptionRule4Count" | "TripDetailExceptionRule4Distance" | "TripDetailExceptionRule5Duration" | "TripDetailExceptionRule5Count" | "TripDetailExceptionRule5Distance" | "TripDetailExceptionRule6Duration" | "TripDetailExceptionRule6Count" | "TripDetailExceptionRule6Distance" | "TripDetailExceptionRule7Duration" | "TripDetailExceptionRule7Count" | "TripDetailExceptionRule7Distance" | "TripDetailExceptionRule8Duration" | "TripDetailExceptionRule8Count" | "TripDetailExceptionRule8Distance" | "TripDetailPrivateTrip" | "TripDetailCategory" | "TripDetailAnnotation" | "TripSummaryName" | "TripSummaryGroupName" | "TripSummaryCustomerDuration" | "TripSummaryNonCustomerDuration" | "TripSummaryDrivingDuration" | "TripSummaryOfficeDepotDuration" | "TripSummaryHomeDuration" | "TripSummaryCustomerStopsCount" | "TripSummaryStopCount" | "TripSummaryCustomerDurationPercentage" | "TripSummaryNonCustomerDurationPercentage" | "TripSummaryDrivingDurationPercentage" | "TripSummaryOfficeDepotDurationPercentage" | "TripSummaryHomeDurationPercentage" | "TripSummaryDistance" | "TripSummaryIdlingDuration" | "TripSummaryIdlingDurationPercentage" | "TripSummaryPeriodStartDate" | "TripSummaryPeriodEndDate" | "TripSummaryPeriodNumber" | "TripSummaryVocation" | "TripSummaryMaximumSpeed" | "TripSummaryOdometerAtStart" | "TripSummaryOdometerAtEnd" | "TripSummaryDaysDriven" | "RestrictedDataModeDistance" | "DebugDateTime" | "DebugRecordType" | "DebugSpeed" | "DebugLongitude" | "DebugLatitude" | "DebugLocation" | "DebugRecordReason" | "DebugRecordDataInHex" | "DebugIgnition" | "DebugAux1" | "DebugAux2" | "DebugAux3" | "DebugAux4" | "DebugAux5" | "DebugAux6" | "DebugAux7" | "DebugAux8" | "DebugPositionValid" | "DebugPositionValidAtUnit" | "DebugLoadedSection" | "DebugDataLength" | "DebugStatusDataValue" | "DiagnosticName" | "DiagnosticId" | "DiagnosticCode" | "ControllerName" | "ControllerId" | "ControllerCode" | "FailureModeName" | "FailureModeId" | "FailureModeCode" | "UnitOfMeasureName" | "UnitOfMeasureId" | "GroupName" | "GroupId" | "GroupComment" | "NodeDetailParents" | "RiskManagementSpeedLimit1Count" | "RiskManagementSpeedLimit2Count" | "RiskManagementSpeedLimit3Count" | "RiskManagementAverageSpeed" | "RiskManagementStopUnder10Count" | "RiskManagementStopOver10Count" | "RiskManagementStopOver20Count" | "RiskManagementStopOver30Count" | "RiskManagementStopOver40Count" | "RiskManagementStopOver50Count" | "RiskManagementIdlingOver5Count" | "RiskManagementIdlingDuration" | "RiskManagementAfterHoursTripCount" | "RiskManagementTotalDistance" | "RiskManagementTotalStopsCount" | "RiskManagementAux1" | "RiskManagementExceptionRule1" | "RiskManagementExceptionRule1Duration" | "RiskManagementExceptionRule1Count" | "RiskManagementExceptionRule1Distance" | "RiskManagementExceptionRule2" | "RiskManagementExceptionRule2Duration" | "RiskManagementExceptionRule2Count" | "RiskManagementExceptionRule2Distance" | "RiskManagementExceptionRule3" | "RiskManagementExceptionRule3Duration" | "RiskManagementExceptionRule3Count" | "RiskManagementExceptionRule3Distance" | "RiskManagementExceptionRule4" | "RiskManagementExceptionRule4Duration" | "RiskManagementExceptionRule4Count" | "RiskManagementExceptionRule4Distance" | "RiskManagementExceptionRule5" | "RiskManagementExceptionRule5Duration" | "RiskManagementExceptionRule5Count" | "RiskManagementExceptionRule5Distance" | "RiskManagementExceptionRule6" | "RiskManagementExceptionRule6Duration" | "RiskManagementExceptionRule6Count" | "RiskManagementExceptionRule6Distance" | "RiskManagementTotalDrivingDuration" | "RiskManagementPeriodStartDate" | "RiskManagementPeriodEndDate" | "RiskManagementPeriodNumber" | "RiskManagementMaxSpeed" | "ExceptionDetailLongitude" | "ExceptionDetailLatitude" | "ExceptionDetailLocation" | "ExceptionDetailStartTime" | "ExceptionDetailEndTime" | "ExceptionDuration" | "ExceptionTripDistance" | "ExceptionStatus" | "ExceptionDistance" | "ExceptionDetailDetails" | "ExceptionDetailExtraInfo" | "LegacyExceptionDetailExtraInfo" | "ExceptionSummaryFirstIncident" | "ExceptionSummaryLastIncident" | "ExceptionSummaryIncidentCount" | "ExceptionSummaryTripDistance" | "ExceptionRuleName" | "ExceptionRuleId" | "ExceptionRuleComment" | "ExceptionRuleGroup" | "TimeCardFirstDepartDate" | "TimeCardLastArriveDate" | "TimeCardLocation" | "TimeCardNonCustomerStopTime" | "TimeCardCustomerStopTime" | "TimeCardTripTime" | "TimeCardIdleTime" | "TimeCardMaxSpeed" | "TimeCardLatitude" | "TimeCardLongitude" | "DriverKeyId" | "DriverKeySerialNumber" | "DriverkeyType" | "UserDesignation" | "UserAuthorityName" | "UserAuthorityAddress" | "UserEmployeeNo" | "UserActiveFrom" | "UserActiveTo" | "UserCompanyName" | "UserCompanyAddress" | "DriverLicenseNumber" | "DriverLicenseProvince" | "UserCarrierNumber" | "UserLastAccessDate" | "UserTimeZone" | "AuditName" | "AuditUserName" | "AuditDateTime" | "AuditComment" | "DisplayUserGroups" | "DisplayUserReportGroups" | "DisplayUserSecurityLevel" | "UserComment" | "UserId" | "UserName" | "UserFirstName" | "UserLastName" | "UserAuthenticationType" | "UserHosRuleSet" | "ServiceStatusDatabase" | "ServiceStatusSource" | "ServiceStatusInfo" | "ServiceStatusLastUpdate" | "ServiceStatusPC" | "ServiceStatusStatus" | "SourceName" | "SourceId" | "EngineTypeName" | "EngineTypeId" | "DataDiagnosticDataLength" | "DataDiagnosticConversion" | "DataDiagnosticOffset" | "ParameterGroupName" | "ParameterGroupId" | "ExceptionInstanceDateTime" | "RouteName" | "RouteId" | "RouteComment" | "RouteDeviceLocalStartDate" | "VehicleDayRouteDriveTime" | "VehicleDayRouteDistance" | "VehicleDayRouteOfficeTime" | "VehicleDayRouteCustomerTimeOverThreshold" | "VehicleDayRouteCustomerTimeUnderThreshold" | "VehicleDayRouteHomeTime" | "VehicleDayRouteUndefinedStopTimeOverThreshold" | "VehicleDayRouteUndefinedStopTimeUnderThreshold" | "VehicleDayRouteTotalStops" | "VehicleDayRouteOfficeStops" | "VehicleDayRouteHomeStops" | "VehicleDayRouteCustomerStopsOverThreshold" | "VehicleDayRouteCustomerStopsUnderThreshold" | "VehicleDayRouteUndefinedStopsOverThreshold" | "VehicleDayRouteUndefinedStopsUnderThreshold" | "VehicleDayRouteLocalFirstDepartureTime" | "VehicleDayRouteLocalLastArrivalTime" | "VehicleDayRouteEmployeeList" | "VehicleDayRoutePercentageSpeeding" | "VehicleDayRouteIdleTime" | "VehicleDayRouteSeatbeltViolations" | "VehicleDayRouteSpeedingViolations" | "VehicleDayRouteJackRabbitStarts" | "VehicleDayRouteSpeedingViolationTime" | "NotificationDateTime" | "NotificationApplicationExceptionDataSource" | "NotificationApplicationExceptionDataDescription" | "NotificationApplicationExceptionDataInfo" | "NotificationInfoDataInstance" | "NotificationInfoDataSource" | "NotificationInfoDataInfo" | "NotificationNewsTextFullInfo" | "FuelTaxCountry" | "FuelTaxJurisdiction" | "FuelTaxUpdatesAvailable" | "FuelTaxEnterTime" | "FuelTaxExitTime" | "FuelTaxEnterOdometer" | "FuelTaxExitOdometer" | "FuelTaxDistance" | "FuelTaxGpsDistance" | "FuelTaxOdometerOffset" | "FuelTaxLatitude" | "FuelTaxLongitude" | "FuelTaxVin" | "FuelTaxLicensePlate" | "FuelTaxIsIftaJurisdiction" | "FuelTaxFuelType" | "FuelTaxFuelPurchased" | "FuelTaxFuelUsed" | "FuelTaxNetTaxableFuel" | "FuelTaxFuelEconomy" | "FuelTaxAuthority" | "FuelTaxTollRoad" | "FuelTaxRoadType" | "ZoneZoneTypes" | "ZoneGroup" | "ZoneName" | "ZoneId" | "ZoneComment" | "ZoneStartTime" | "ZoneEndTime" | "ZoneDisplayed" | "ZoneIsStopExceptionRequired" | "ZoneExternalReference" | "ZoneFillColor" | "ZoneCentroidLongitude" | "ZoneCentroidLatitude" | "CongregationStart" | "CongregationEnd" | "StopStart" | "StopEnd" | "StopLocation" | "DeviceStatusLastHeartBeat" | "DeviceStatusLastFaultData" | "DeviceStatusLastEngineData" | "FaultDataId" | "FaultDataDateTime" | "FaultDataFaultLampState" | "FaultDataFaultState" | "FaultDataCount" | "FaultDataDismissDateTime" | "FaultDataClass" | "FaultDataSeverity" | "FaultDataSourceAddress" | "FlashCodeName" | "FlashCodeId" | "FlashCodeCircuitIndex" | "FlashCodeFlashCodeIndex" | "FlashCodeHelpUrl" | "FlashCodePriorityLevel" | "FlashCodePageReference" | "FaultDataAmberWarningLamp" | "FaultDataRedStopLamp" | "FaultDataMalfunctionLamp" | "FaultDataProtectWarningLamp" | "StatusDataDateTime" | "StatusDataData" | "SensorDataAddress" | "DeviceDetailsCurrentOdometer" | "DeviceDetailsLastStopLongitude" | "DeviceDetailsLastStopLatitude" | "DeviceDetailsLocation" | "DeviceDetailsCurrentEngineHours" | "DeviceDeviceType" | "DeviceProductId" | "DeviceMajor" | "DeviceMinor" | "DeviceSerialNumber" | "DeviceLicensePlate" | "DeviceLicenseState" | "DeviceVIN" | "DeviceEngineVIN" | "DeviceSleeperBerth" | "DeviceDetailsMake" | "DeviceDetailsModel" | "DeviceDetailsYear" | "DeviceDetailsExtra" | "DeviceTimeZoneId" | "DeviceStatusLastTrip" | "DeviceStatusLastGpsRecord" | "DeviceStatusLastStatusData" | "DeviceStatusAnalysisTroubleDownloadStatus" | "DeviceDetailsDrivingState" | "DeviceDetailsPrivacyMode" | "RouteItemRouteName" | "RouteItemLegName" | "RouteItemTurnNumber" | "RouteItemTurnText" | "RouteItemDistance" | "RouteItemDuration" | "EventRuleKilometers" | "EventRuleMonths" | "EventRuleDayOfMonthSelect" | "EventRuleWeeks" | "EventRuleDayOfWeekSelect" | "EventRuleDays" | "EventRuleGroups" | "EventRuleDateTime" | "EventRuleEngineHours" | "EventRuleComment" | "ReminderEventCurrentOdometer" | "EventOccuranceEventDate" | "EventOccuranceAdjustedOdometer" | "EventOccuranceComment" | "EventOccurrenceReference" | "EventOccurrenceLaborCostInput" | "EventOccurrenceLaborCostConverted" | "EventOccurrencePartsCostInput" | "EventOccurrencePartsCostConverted" | "EventOccurrenceTaxInput" | "EventOccurrenceTaxConverted" | "EventOccurrenceTotalCostInput" | "EventOccurrenceTotalCostConverted" | "EventOccurrenceCostCurrencyInput" | "EventOccurrenceCostCurrencyConverted" | "ReminderEventEventRuleType" | "ReminderEventDueDate" | "ReminderEventDueDistance" | "ReminderEventDueEngineHours" | "EventRuleName" | "EventRuleId" | "EventOccuranceCurrentOdometer" | "EventOccuranceCurrentEngineHours" | "EventOccuranceAdjustedEngineHours" | "KeyInsertDataLogDate" | "DeviceInstallResultDate" | "DeviceInstallResultAllDownload" | "DeviceInstallResultLastGpsRecord" | "DeviceInstallResultLastEngineRecord" | "DeviceInstallResultSimNumber" | "DeviceInstallResultSimActive" | "DeviceInstallResultComments" | "DeviceInstallRequestSerialNumber" | "DeviceInstallRequestHardwareId" | "DeviceInstallRequestDate" | "DeviceInstallRequestInstallerName" | "DeviceInstallRequestInstallerCompany" | "DeviceInstallRequestOdometer" | "DeviceInstallRequestAsset" | "DeviceInstallRequestComments" | "DeviceInstallHistoryRecordType" | "DeviceInstallHistoryStatus" | "DeviceInstallMakeAndModel" | "DeviceInstallIox" | "DeviceInstallHarness" | "DeviceInstallHarnessComments" | "DeviceInstallAuxPorts" | "DeviceInstallComment" | "DeviceInstallWorkReference" | "DeviceInstallEngineHours" | "DeviceInstallEngineProtocol" | "DeviceInstallLastDeviceCommunication" | "DeviceInstallPossibleIssues" | "DeviceInstallPhoto1" | "DeviceInstallPhoto2" | "DeviceInstallPhoto3" | "DeviceInstallPhoto4" | "PerformanceDateTime" | "PerformanceProcessContext" | "PerformanceSource" | "PerformanceLevel1Action" | "PerformanceLevel2Action" | "PerformanceLevel3Action" | "PerformanceCpuSeconds" | "PerformanceSeconds" | "PerformanceLevel1Count" | "PerformanceLevel2Count" | "PerformanceLevel3Count" | "PerformanceTotalCpuSeconds" | "PerformanceTotalSeconds" | "PerformanceAction" | "PerformanceLastValue" | "PerformanceMinValue" | "PerformanceMaxValue" | "PerformanceTotalValue" | "PerformanceAverageValue" | "PerformanceCount" | "DeviceProgrammingImmobilizeArming" | "DeviceProgrammingSpeedingOn" | "DeviceProgrammingSpeedingOff" | "DeviceProgrammingIdleMinutes" | "DeviceProgrammingRpmValue" | "DeviceProgrammingHarshBrakeWarning" | "DeviceProgrammingOdometerOffset" | "DeviceProgrammingEngineHourOffset" | "EngineStatusStatisticsPeriodStartDate" | "EngineStatusStatisticsPeriodEndDate" | "EngineStatusStatisticsDistance" | "EngineStatusStatisticsFuelUsed" | "EngineStatusStatisticsZeroSpeedFuelUsed" | "EngineStatusStatisticsFuelEconomyMetric" | "EngineStatusStatisticsFuelEconomyUS" | "EngineStatusStatisticsIdling" | "EngineStatusStatisticsPeriodNumber" | "EngineStatusStatisticsFuelEconomy" | "EngineStatusStatisticsElectricEnergyUsed" | "EngineStatusStatisticsElectricEnergyUsedFuelEquivalent" | "EngineStatusStatisticsElectricEnergyEconomy" | "EngineStatusStatisticsFuelAndElectricEconomy" | "EngineStatusStatisticsElectricEnergyUsedPercentage" | "EngineStatusStatisticsGpsDistance" | "TextMessageSentDate" | "TextMessageDeliveredDate" | "TextMessageDirectionToVehicle" | "TextMessageReadDate" | "TextMessageContentMessage" | "LocationContentLatitude" | "LocationContentLongitude" | "LocationContentAddress" | "CannedResponseOptionsString" | "RouteComparisonDetailExpectedSequence" | "RouteComparisonDetailActualSequence" | "RouteComparisonDetailExpectedArrivalTime" | "RouteComparisonDetailActualArrivalTime" | "RouteComparisonDetailLatitude" | "RouteComparisonDetailLongitude" | "RouteComparisonDetailExpectedStopDuration" | "RouteComparisonDetailActualStopDuration" | "RouteComparisonDetailIdling" | "RouteComparisonDetailLocation" | "RouteComparisonDetailStartDateTime" | "RouteComparisonDetailEndDateTime" | "RouteComparisonDetailOfficeName" | "RouteComparisonDetailExpectedDrivingDistance" | "RouteComparisonDetailActualDrivingDistance" | "RouteComparisonDetailExpectedDrivingTimeSpan" | "RouteComparisonDetailActualDrivingTimeSpan" | "DVIRLogDateTimeCreated" | "DVIRLogDriverRemark" | "DVIRLogRepairDate" | "DVIRLogRepairRemark" | "DVIRDefects" | "DVIRLogCertifyDate" | "DVIRLogCertifyRemark" | "DVIRLogIsSafeToOperate" | "DVIRLogLogType" | "DVIRDetailOdometer" | "DVIRDetailHubometer" | "DVIRLogDetailInspector" | "DVIRLogDetailOperator" | "DVIRLogLoadHeight" | "DVIRLogLoadWidth" | "DVIRLogAuthorityName" | "DVIRLogAuthorityAddress" | "DVIRLogDeviceVin" | "DVIRDetailAddress" | "DVIRDetailDefects" | "DVIRDetailNormalDefects" | "DVIRDetailUnregulatedDefects" | "DVIRDetailCriticalDefects" | "DVIRDetailDefectName" | "DVIRDetailDefectSeverityLevel" | "DVIRDetailDefectRepairStatus" | "DVIRDefectRepairDateTime" | "DVIRDetailDefectRemark" | "DutyStatusId" | "DutyStatusFromPreviousPeriod" | "DutyStatusDateTime" | "DutyStatusStatus" | "DutyStatusVerifyDateTime" | "DutyStatusEditDateTime" | "DutyStatusCoDrivers" | "DutyStatusLocation" | "DutyStatusOrigin" | "DutyStatusParentId" | "DutyStatusState" | "DutyStatusVersion" | "DutyStatusDetailOdometer" | "DutyStatusDetailLatitude" | "DutyStatusDetailLongitude" | "DutyStatusDetailDistance" | "DutyStatusDetailTrailers" | "DutyStatusDetailShipments" | "DutyStatusDetailHosRuleSet" | "DutyStatusDetailAnnotations" | "DutyStatusDetailDuration" | "DutyStatusSequence" | "DutyStatusMalfunctionType" | "HosViolationDrivingDuration" | "HosViolationStartDateTime" | "HosViolationEndDateTime" | "HosViolationReason" | "HosViolationHoursLimit" | "HosViolationDaysLimit" | "HosViolationType" | "HosAvailabilityRest" | "HosAvailabilityDriving" | "HosAvailabilityDuty" | "HosAvailabilityWorkday" | "HosAvailabilityCycle" | "TrailerComment" | "TrailerId" | "TrailerName" | "TrailerGroups" | "DeviceActiveFrom" | "DeviceActiveTo" | "DeviceDetailsDevicePlan" | "DeviceDetailsCurrentExceptions" | "DeviceTimeToDownload" | "DeviceIgnoreDownloadsUntil" | "DeviceProgrammingImmobilizeUnit" | "DeviceProgrammingSpeedIndicator" | "DeviceProgrammingSpeedWarning" | "DeviceProgrammingBeepOnIdle" | "DeviceProgrammingBeepOnRpm" | "DeviceProgrammingAux1Warning" | "DeviceProgrammingAux2Warning" | "DeviceProgrammingAux3Warning" | "DeviceProgrammingAux4Warning" | "DeviceProgrammingAux5Warning" | "DeviceProgrammingAux6Warning" | "DeviceProgrammingAux7Warning" | "DeviceProgrammingAux8Warning" | "DeviceProgrammingAux1WarningSpeed" | "DeviceProgrammingAux2WarningSpeed" | "DeviceProgrammingAux3WarningSpeed" | "DeviceProgrammingAux4WarningSpeed" | "DeviceProgrammingAux5WarningSpeed" | "DeviceProgrammingAux6WarningSpeed" | "DeviceProgrammingAux7WarningSpeed" | "DeviceProgrammingAux8WarningSpeed" | "NotificationRowRecipientType" | "FuelEventDateTime" | "FuelEventProductType" | "FuelEventVolume" | "FuelEventOdometer" | "FuelEventCost" | "FuelEventCurrencyCode" | "FuelUsedEventDistance" | "FuelUpEventTotalFuelUsed" | "FuelUpEventTankCapacity" | "FuelUpEventTankCapacitySource" | "FuelUpEventTankLevelLow" | "FuelUpEventTankLevelHigh" | "FuelTransacationVin" | "FuelTransacationDriverName" | "FuelTransaction1Latitude" | "FuelTransaction1Longitude" | "FuelTransaction2Latitude" | "FuelTransaction2Longitude" | "FuelTransaction3Latitude" | "FuelTransaction3Longitude" | "FuelTransaction4Latitude" | "FuelTransaction4Longitude" | "FuelUpEventRiskIsLocationMatch" | "FuelUpEventRiskIsCapacityMatch" | "FuelUpEventRiskIsEngineFuelMatch" | "FuelUpEventRiskIsDerivedVolumeMatch" | "FillUpRecordLocation" | "FillUpRecordLatitude" | "FillUpRecordLongitude" | "FillUpRecordTransaction1Driver" | "FillUpRecordTransaction1DateTime" | "FillUpRecordTransaction1Cost" | "FillUpRecordTransaction1CurrencyCode" | "FillUpRecordTransaction1Odometer" | "FillUpRecordTransaction1Vin" | "FillUpRecordTransaction1ProductType" | "FillUpRecordTransaction1ProductDescription" | "FillUpRecordTransaction1CardNumber" | "FillUpRecordTransaction1SiteName" | "FillUpRecordTransaction2Driver" | "FillUpRecordTransaction2DateTime" | "FillUpRecordTransaction2Cost" | "FillUpRecordTransaction2CurrencyCode" | "FillUpRecordTransaction2Odometer" | "FillUpRecordTransaction2Vin" | "FillUpRecordTransaction2ProductType" | "FillUpRecordTransaction2ProductDescription" | "FillUpRecordTransaction2CardNumber" | "FillUpRecordTransaction2SiteName" | "FillUpRecordTransaction3Driver" | "FillUpRecordTransaction3DateTime" | "FillUpRecordTransaction3Cost" | "FillUpRecordTransaction3CurrencyCode" | "FillUpRecordTransaction3Odometer" | "FillUpRecordTransaction3Vin" | "FillUpRecordTransaction3ProductType" | "FillUpRecordTransaction3ProductDescription" | "FillUpRecordTransaction3CardNumber" | "FillUpRecordTransaction3SiteName" | "FillUpRecordTransaction4Driver" | "FillUpRecordTransaction4DateTime" | "FillUpRecordTransaction4Cost" | "FillUpRecordTransaction4CurrencyCode" | "FillUpRecordTransaction4Odometer" | "FillUpRecordTransaction4Vin" | "FillUpRecordTransaction4ProductType" | "FillUpRecordTransaction4ProductDescription" | "FillUpRecordTransaction4CardNumber" | "FillUpRecordTransaction4SiteName" | "FillUpRecordFuelEconomy" | "ChargeEventStartDate" | "ChargeEventDuration" | "ChargeEventLocation" | "ChargeEventZones" | "ChargeEventStartCharge" | "ChargeEventEndCharge" | "ChargeEventSessionStartCharge" | "ChargeEventSessionEndCharge" | "ChargeEventDeviceAverageStartCharge" | "ChargeEventDeviceAverageEndCharge" | "ChargeEventEnergyAdded" | "ChargeEventElectricEconomy" | "ChargeEventMaxPower" | "ChargeEventElectricCurrentType" | "ChargeEventACVoltage" | "ChargeEventStartOdometer" | "ChargeSessionTripStopTime" | "EngineFaultSummaryActiveFaultDataCount" | "EngineFaultSummaryFaultDataCount" | "EngineFaultSummaryLastFault" | "DVIRLogId" | "DeviceDetailsVocation" | "DeviceDetailsElectricalSystemRating" | "StartOfWorkday" | "AutoVehicleManagement" | "HosSettings" | "DutyStatusIgnoredLog" | "MaterialManagementStartDate" | "MaterialManagementEndDate" | "MaterialManagementSolidType" | "MaterialManagementPreWetType" | "MaterialManagementAntiIceType" | "MaterialManagementSolidTotal" | "MaterialManagementPreWetTotal" | "MaterialManagementAntiIceTotal" | "MaterialManagementSpreadTime" | "MaterialManagementPlowTime" | "MaterialManagementDeadheadTime" | "MaterialManagementTravelTime" | "MaterialManagementIdleTime" | "MaterialManagementTotalTime" | "MaterialManagementSpreadDistance" | "MaterialManagementPlowDistance" | "MaterialManagementDeadheadDistance" | "MaterialManagementTotalDistance" | "MaterialManagementAvgSolidRate" | "MaterialManagementAvgPreWetRate" | "MaterialManagementAvgAntiIceRate" | "TransactionFuelVolume" | "EngineDataFuelVolume" | "OBDAlertStatus" | "RouteCompletionPassCount" | "RouteCompletionExpectedPassCount" | "RouteCompletionCompletionPercentage" | "RouteCompletionDevices" | "FaultDataStatus" | "StatusDataRecordDisplayData" | "StatusDataRecordUnitOfMeasureName" | "DebuggingStatusRecordDisplayData" | "DebuggingStatusRecordUnitOfMeasureName" | "TripStartEVBatteryCharge" | "TripEndEVBatteryCharge" | "TripElectricEnergyUsedWhileDriving" | "TripElectricEnergyUsedWhileIdling" | "TripElectricEnergyUsed" | "TripElectricEnergyEconomy" | "DVIRDetailNeedsCertify" | "EVBatteryHealthMake" | "EVBatteryHealthModel" | "EVBatteryHealthYear" | "EVBatteryHealthEVType" | "EVBatteryHealthDetectionDate" | "EVBatteryHealth90DayRollingAverageDataCollectionStartDate" | "EVBatteryHealth90DayRollingAverageDataCollectionEndDate" | "EVBatteryHealthDetectionDateOdometer" | "EVBatteryHealthEVBatteryHealth" | "EVBatteryHealthLower90ConfidenceInterval" | "EVBatteryHealthLower90ConfidenceIntervalDelta" | "EVBatteryHealthUpper90ConfidenceInterval" | "EVBatteryHealthUpper90ConfidenceIntervalDelta" | "EVBatteryHealthUsableDetectedCapacity" | "EVBatteryHealthUsableDetectedCapacity90ConfidenceInterval" | "EVBatteryHealthUsableOriginalCapacity" | "EVBatteryHealthUsableOriginalCapacity90ConfidenceInterval" | "EVBatteryHealthUsableDetectedCapacitySource" | "EVBatteryHealthUsableOriginalCapacitySource" | "EVBatteryHealthUsableDetectedCapacityLower90ConfidenceInterval" | "EVBatteryHealthUsableDetectedCapacityUpper90ConfidenceInterval" | "EVBatteryHealthUsableOriginalCapacityLower90ConfidenceInterval" | "EVBatteryHealthUsableOriginalCapacityUpper90ConfidenceInterval"

The report heading.

Defined in

src/types/Checkmate/Reports/ReportHeading.ts:6


ReportPeriod

Ƭ ReportPeriod: "None" | "PreviousHour" | "Today" | "Yesterday" | "ThisWeek" | "LastWeek" | "ThisMonth" | "LastMonth" | "PreviousDay" | "PreviousWeek" | "LastThreeMonths" | "PreviousFourWeeks" | "LastSixMonths" | "LastTwelveMonths" | "YearToDate" | "PreviousTwoWeeks" | "Custom" | "ThisWorkingWeek" | "LastWorkingWeek" | "PreviousThirtyDays" | "LastQuarter"

Used to represent the duration for which the report is generated.

Defined in

src/types/Checkmate/ObjectModel/ReportPeriod.ts:6


ReportProcessingStatus

Ƭ ReportProcessingStatus: "Initialized" | "Processing" | "Successful" | "Error"

The enum representing all the report processing statuses.

Defined in

src/types/Checkmate/ObjectModel/ReportProcessingStatus.ts:6


ReportScheduleGroupType

Ƭ ReportScheduleGroupType: "DataScope" | "IncludeAllChildren" | "IncludeDirectChildrenOnly"

The way to treat nodes in report schedule.

Defined in

src/types/Checkmate/ObjectModel/ReportScheduleGroupType.ts:6


ReportTemplateType

Ƭ ReportTemplateType: "Custom" | "Report" | "Advanced" | "Dashboard" | "Preloaded"

Report template type for ReportTemplate.

Defined in

src/types/Checkmate/ObjectModel/ReportTemplateType.ts:6


ReprocessRequestStatus

Ƭ ReprocessRequestStatus: "Scheduled" | "Processing" | "Success" | "Failure" | "Cancelled" | "Complete" | "Unknown"

Describes the state of a ReprocessRequest or a DeviceReprocessRequest.

Defined in

src/types/Checkmate/ObjectModel/Reprocessing/ReprocessRequestStatus.ts:6


RequireTraining

Ƭ RequireTraining: "Unknown" | "Yes" | "No" | "Maybe"

Indicates whether administrator of data base requires training or not

Defined in

src/types/Checkmate/ObjectModel/Registration/RequireTraining.ts:6


RouteStatus

Ƭ RouteStatus: "Unplanned" | "Planned" | "EnRoute" | "Completed" | "Incomplete"

Route plan status

Defined in

src/types/Checkmate/ObjectModel/RouteStatus.ts:6


RouteType

Ƭ RouteType: "Basic" | "Plan" | "Service"

A type of Route.

Defined in

src/types/Checkmate/ObjectModel/RouteType.ts:6


RuleMonitorType

Ƭ RuleMonitorType: "None" | "Zone" | "Diagnostic" | "StatusStatistics" | "PercentageOverSpeedLimit" | "Location"

Defines different rule monitor types.

Defined in

src/types/Checkmate/ObjectModel/Exceptions/RuleMonitorType.ts:6


ScheduleFrequency

Ƭ ScheduleFrequency: "Daily" | "Weekly"

Schedule Frequency.

Defined in

src/types/Checkmate/ObjectModel/ScheduleFrequency.ts:6


SearchRelation

Ƭ SearchRelation: "And" | "Or"

Search the groups

Defined in

src/types/Checkmate/ObjectModel/SearchRelation.ts:6


SearchTypes

Ƭ SearchTypes: Object

Type declaration

Name Type
AddIn AddInSearch
AddInData AddInDataSearch
AnnotationLog AnnotationLogSearch
Audit AuditSearch
BackfillStatus BackfillStatusSearch
BinaryData BinaryDataSearch
Certificate CertificateSearch
ChargeEvent ChargeEventSearch
Controller ControllerSearch
CustomData CustomDataSearch
DVIRDefect DVIRDefectSearch
DVIRLog DVIRLogSearch
Dashboard DashboardSearch
DebugData DebugDataSearch
Defect DefectSearch
DefectRemark DefectRemarkSearch
Device DeviceSearch
DeviceLink DeviceLinkSearch
DeviceMasterFlag DeviceMasterFlagSearch
DeviceRegistrationState DeviceRegistrationStateSearch
DeviceReplacementInfo DeviceReplacementInfoSearch
DeviceReprocessRequest DeviceReprocessRequestSearch
DeviceShare DeviceShareSearch
DeviceStatusInfo DeviceStatusInfoSearch
Diagnostic DiagnosticSearch
DiagnosticMapping DiagnosticMappingSearch
DisplayMeasurementProfile DisplayMeasurementProfileSearch
DisplayMeasurementProfileDetail DisplayMeasurementProfileDetailSearch
DisplayUnitOfMeasure DisplayUnitOfMeasureSearch
DistributionList DistributionListSearch
DriverChange DriverChangeSearch
DriverRegulation DriverRegulationSearch
DutyStatusAvailability DutyStatusAvailabilitySearch
DutyStatusLog DutyStatusLogSearch
DutyStatusViolation DutyStatusViolationSearch
EmployeeRoutePlan EmployeeRoutePlanSearch
EnergySnapshotRecord EnergySnapshotRecordSearch
EngineType EngineTypeSearch
EntityLinkRule EntityLinkRuleSearch
EntitySetting EntitySettingSearch
EventDeviation EventDeviationSearch
EventOccurrence EventOccurrenceSearch
EventOccurrenceDue EventOccurrenceDueSearch
EventRule EventRuleSearch
ExceptionEvent ExceptionEventSearch
ExceptionEventAttachment ExceptionEventAttachmentSearch
ExceptionEventComment ExceptionEventCommentSearch
FailureMode FailureModeSearch
FaultData FaultDataSearch
FeedVersionTrackingData FeedVersionTrackingDataSearch
FillUp FillUpSearch
FuelSnapshotRecord FuelSnapshotRecordSearch
FuelTaxDetail FuelTaxDetailSearch
FuelTransaction FuelTransactionSearch
FuelUpEvent FuelUpEventSearch
FuelUsed FuelUsedSearch
Group GroupSearch
GroupDevice GroupDeviceSearch
GroupFilter GroupFilterSearch
GroupZoneMetadata GroupZoneMetadataSearch
HosRulesetConfig HosRulesetConfigSearch
InstallRecord InstallRecordSearch
IoxAddOn IoxAddOnSearch
IoxAddOnStatus IoxAddOnStatusSearch
LiveCompletionMapConfig LiveCompletionMapConfigSearch
LogRecord LogRecordSearch
LogRecordZoneDistance LogRecordZoneDistanceSearch
MaintenanceNotificationRule MaintenanceNotificationRuleSearch
MaintenanceNotificationState MaintenanceNotificationStateSearch
MediaFile MediaFileSearch
MimeTask MimeTaskSearch
Notification NotificationSearch
ParameterGroup ParameterGroupSearch
Property PropertySearch
PropertySet PropertySetSearch
Recipient RecipientSearch
ReportStorage ReportStorageSearch
ReportTemplate ReportTemplateSearch
RestrictedDataModeChange RestrictedDataModeChangeSearch
Route RouteSearch
RouteExtract RouteExtractSearch
Rule RuleSearch
SecurityId SecurityIdSearch
ServiceState ServiceStateSearch
ShareableLink ShareableLinkSearch
ShipmentLog ShipmentLogSearch
Source SourceSearch
StatusData StatusDataSearch
TachographActivitiesCertificate TachographActivitiesCertificateSearch
TachographCompanyCard TachographCompanyCardSearch
TachographDataFile TachographDataFileSearch
TachographVehicleInspection TachographVehicleInspectionSearch
TextMessage TextMessageSearch
Trailer TrailerSearch
TrailerAttachment TrailerAttachmentSearch
Trip TripSearch
TripAnnotation TripAnnotationSearch
TripGeohash TripGeohashSearch
TripTypeChange TripTypeChangeSearch
UnitOfMeasure UnitOfMeasureSearch
User UserSearch
UserDeviceLink UserDeviceLinkSearch
UserDisplayProfile UserDisplayProfileSearch
UserHosRuleSet UserHosRuleSetSearch
UserLoginStatus UserLoginStatusSearch
UserSupport UserSupportSearch
VirtualExceptionEvent VirtualExceptionEventSearch
Widget WidgetSearch
WifiHotspot WifiHotspotSearch
WorkHoliday WorkHolidaySearch
WorkTime WorkTimeSearch
Zone ZoneSearch
ZoneType ZoneTypeSearch

Defined in

src/types/SearchTypes.ts:115


SecurityIdentifier

Ƭ SecurityIdentifier: "Unknown" | "Everything" | "SystemSettings" | "ImportFromOtherDatabase" | "AuditLog" | "UserList" | "UserAdmin" | "PurgeData" | "DeviceList" | "EngineManagementReport" | "ZoneTypeList" | "ReprocessData" | "WorkTimeList" | "WorkHolidayList" | "ZoneList" | "ZoneAdmin" | "ExceptionsList" | "ReminderReport" | "EventOccurrenceList" | "NodesList" | "ReminderRuleList" | "ChangePassword" | "CreateExtractKey" | "CreateTestKey" | "CreateFirmwareKey" | "CreateProgrammingKey" | "CreateKeyBackup" | "RestoreKeyBackup" | "CreateWifiKey" | "ImportZones" | "NotificationList" | "OrganizeViews" | "RouteList" | "UserSettings" | "EngineDiagnosticList" | "EngineTypeList" | "EngineFailureModeList" | "EngineFlashCodelist" | "EngineUnitOfMeasureList" | "TripsActivityReport" | "CongregationReport" | "CustomerVisitsReport" | "SpeedProfileReport" | "TimeCardReport" | "EngineStatusDataGraph" | "ExceptionsReport" | "RiskManagementReport" | "RouteSummaryReport" | "UnassignedRouteReport" | "AccidentDebugReport" | "DeviceInstallHistoryReport" | "LaunchAddIn" | "DeviceAdmin" | "DeviceAdminDeleteUnplugReplace" | "KeyInformation" | "SecurityClearanceList" | "TrackHistoricData" | "ServicesSettings" | "MileageSummaryDashboard" | "AccidentWizard" | "FuelTax" | "ManageReportTemplates" | "ViewReportTemplate" | "ExportFromOtherDatabase" | "ViewGpsTextMessage" | "SendGpsTextMessage" | "DeleteGpsTextMessage" | "RequestDeviceLocation" | "DisplayMap" | "StartFullVersion" | "EditNotificationEmailTemplate" | "DeviceAdminAdvanced" | "DeviceAdminDriverFeedback" | "EditDeviceOdometer" | "SendExternalRelayInstruction" | "AboutCheckmate" | "FuelUsageReport" | "DriverBlacklist" | "EditException" | "EditDistributionList" | "RouteComparisonReport" | "ManageHOSLogs" | "ViewHOSLogs" | "ViewDVIRLogs" | "ManageDVIRLogs" | "ViewTrailers" | "ManageTrailers" | "ViewShipments" | "ManageShipments" | "ViewAdvancedHelp" | "EditRoadSpeeds" | "FuelTransactionList" | "FuelTransactionAdmin" | "ViewMarketplacePaidItems" | "ViewCertificates" | "ManageCertificates" | "RepairDVIR" | "PurchaseMarketplacePaidItems" | "ManageAddInData" | "ViewAddInData" | "ViewBinaryData" | "DriverIdentificationClearance" | "AccelerometerDataClearance" | "ServicePlansClearance" | "AuxiliaryClearance" | "EngineStatusDataClearance" | "ResellerControlClearance" | "GoTalkClearance" | "StatusGroupsClearance" | "ProductGuideClearance" | "FeaturePreviewClearance" | "NewsNotificationsClearance" | "ManageAddinsClearance" | "DeviceCurrentStatusClearance" | "ViewTripTypeChangeData" | "EditTripTypeChangeData" | "DirectSupportAdmin" | "ViewBusinessIntelligence" | "ActiveTrackingClearance" | "ContinuousConnectClearance" | "CertifyDVIR" | "InspectDVIR" | "ViewMedia" | "ManageMedia" | "ViewGroups" | "AdministerWiFiHotspotSettings" | "ViewWiFiHotspotSettings" | "MaterialManagementReport" | "ViewDeviceShare" | "EditDeviceShare" | "InstallRecord" | "ViewUserDeviceLink" | "EditUserDeviceLink" | "RouteCompletionReport" | "ViewActiveInsights" | "ViewAnalyticsLab" | "ViewShareableLink" | "CreateShareableLink" | "DeleteShareableLink" | "ViewDeviceDataPrivacyChangeData" | "EditDeviceDataPrivacyChangeData" | "IgnoreHOSLogs" | "AdministerPropertySet" | "ViewPropertySet" | "AdministerProperty" | "ViewProperty" | "ViewSharedDevice" | "ManageDriverActivityGroup" | "ViewTripAnnotation" | "ManageTripAnnotation" | "ExceptionEventReviewer" | "ExceptionEventReviewParticipant" | "ViewBinaryDataFiles" | "ManageBinaryDataFiles" | "ModifyGroupFilter" | "ViewGroupFilter" | "AdministerLiveMap" | "ViewLiveMap" | "EVBatteryHealthReport" | "ManageTachographInspection" | "ViewTachographInspection" | "ManageTachographCompanyCards" | "ViewTachographCompanyCards" | "TachographDownloadAndUploadFiles" | "ViewTachographRemoteDownloadData" | "ViewTachographDrivingTimeData" | "ViewTachographInfringementData" | "SendColdChainCommand" | "EditStockRules" | "ResetPassword"

The list of identifiers that gives a security identity to something whose access can be controlled.

Defined in

src/types/Checkmate/ObjectModel/SecurityIdentifier.ts:6


SecurityRole

Ƭ SecurityRole: "Unknown" | "UserView" | "UserRemove" | "UserSet" | "UserInsert" | "DeviceView" | "DeviceRemove" | "DeviceInsert" | "DeviceSet" | "ZoneView" | "ZoneRemove" | "ZoneInsert" | "ZoneSet" | "ZoneTypeView" | "ZoneTypeRemove" | "ZoneTypeInsert" | "ZoneTypeSet" | "RouteView" | "RouteRemove" | "RouteInsert" | "RouteSet" | "DatabaseUpgrade" | "DatabaseMigrate" | "ExportDatabase" | "ImportDatabase" | "ServerUpgrade" | "SysSetCompanyGUID" | "SysSettingsSetAll" | "EventRemove" | "EventInsert" | "EventSet" | "EventRuleRemove" | "EventRuleInsert" | "EventRuleSet" | "EventRuleView" | "EventTypeRemove" | "EventTypeInsert" | "EventTypeSet" | "ExceptionRuleView" | "ExceptionRuleRemove" | "ExceptionRuleInsert" | "ExceptionRuleSet" | "DistributionListView" | "DistributionListRemove" | "DistributionListInsert" | "DistributionListSet" | "UomRemove" | "UomInsert" | "UomSet" | "DiagnosticView" | "DiagnosticRemove" | "DiagnosticInsert" | "DiagnosticSet" | "MappedDiagnosticRemove" | "MappedDiagnosticInsert" | "MappedDiagnosticSet" | "DiagnosticMappingRemove" | "DiagnosticMappingInsert" | "DiagnosticMappingSet" | "FailureModeView" | "FailureModeRemove" | "FailureModeInsert" | "FailureModeSet" | "WorkTimesView" | "WorkTimesRemove" | "WorkTimesInsert" | "WorkTimesSet" | "WorkHolidaysView" | "WorkHolidaysRemove" | "WorkHolidaysInsert" | "WorkHolidaysSet" | "EngineTypeView" | "EngineTypeRemove" | "EngineTypeInsert" | "EngineTypeSet" | "FlashCodeRemove" | "FlashCodeInsert" | "FlashCodeSet" | "HistoricDeviceRemove" | "HistoricDeviceInsert" | "HistoricDeviceSet" | "HistoricDeviceMakeHistoric" | "HistoricDeviceUnMakeHistoric" | "HosLogRemove" | "HosLogAdd" | "HosLogEdit" | "DvirLogAdd" | "DvirLogSet" | "DvirLogRemove" | "ProcessManualUpdate" | "ReportAuditLog" | "ReportSpeedProfile" | "ReportCongregation" | "ReportZoneVisitsDetail" | "ReportZoneVisitsSummary" | "ReportDVIRLog" | "ReportDebug" | "ReportDeviceInstallHistory" | "ReportDevice" | "ReportDiagnosticList" | "ReportEngineFault" | "ReportEngineStatus" | "ReportEngineSummary" | "ReportEventHistory" | "ReportEventRuleDevice" | "ReportExceptionsDetail" | "ReportExceptionsSummary" | "ReportFillUps" | "ReportFuelTax" | "ReportEngineStatusStatistics" | "ReportGroupsList" | "ReportHosLogs" | "ReportHosViolation" | "ReportNotification" | "ReportReminders" | "ReportRiskManagement" | "ReportRouteComparisonDetail" | "ReportRouteDirection" | "ReportRouteSummary" | "ReportTextMessage" | "ReportTimeCard" | "ReportTripsDetail" | "ReportTripsSummary" | "ReportUnassignedRoute" | "ReportUserList" | "ReportZoneList" | "ReportExceptionsSummaryGraph" | "ReportTripsIdlingSummaryGraph" | "ReportFleetSummaryGraph" | "ReportCustomerStopGraph" | "ReportTripsDensitySummaryGraph" | "ReportEVBatteryHealth" | "ShowMap" | "Purge" | "ExcelReportView" | "ExcelReportRemove" | "ExcelReportEdit" | "ExcelReportInsert" | "KeyCreate" | "KeyBackup" | "KeyRestore" | "KeyDataDownload" | "UserLogin" | "UserLogoff" | "UserLoginFailure" | "UserLockout" | "UserUnlocked" | "RequestLocation" | "GpsTextMessageSend" | "GpsTextMessageDelete" | "GpsTextMessageView" | "NotificationView" | "NotificationsDismiss" | "NotificationTemplateView" | "NotificationTemplateRemove" | "NotificationTemplateSet" | "NotificationTemplateInsert" | "NodeView" | "NodeRemove" | "NodeSet" | "NodeInsert" | "SecurityGroupView" | "KeyInsert" | "TrailerView" | "TrailerRemove" | "TrailerSet" | "TrailerInsert" | "DriverChangeRemove" | "DriverChangeInsert" | "CustomReportScheduleInsert" | "CustomReportScheduleSet" | "CustomReportScheduleRemove" | "CustomReportSendError" | "FuelTransactionView" | "FuelTransactionRemove" | "FuelTransactionInsert" | "FuelTransactionSet" | "PostedRoadSpeedSet" | "FillUpsGraph" | "MiscPageView" | "AboutView" | "DashboardView" | "RadioDownloaderView" | "FuelTransactionImport" | "DriveLockUserCleared" | "PasswordResetRequest" | "DefectGroupView" | "CertificateInsert" | "CertificateRemove" | "CertificateSet" | "ReportHosAvailability" | "TripTypeChangeInsert" | "TripTypeChangeRemove" | "ShipmentLogInsert" | "ShipmentLogSet" | "ShipmentLogRemove" | "TrailerAttachmentInsert" | "TrailerAttachmentSet" | "TrailerAttachmentRemove" | "SupportTicketInsert" | "TrainingTicketInsert" | "SupportTicketSet" | "TrainingTicketSet" | "EmailSent" | "SkipHosVerify" | "SkipHosClaimUnassigned" | "SkipDvirInspect" | "ELDDataTransfer" | "CreditsView" | "ReportChargeEvent" | "HardwarePurchase" | "MediaFileView" | "MediaFileRemove" | "MediaFileInsert" | "MediaFileSet" | "MediaFileUpload" | "WiFiView" | "WiFiRemove" | "WiFiSet" | "WiFiInsert" | "UserSupportInsert" | "UserSupportRemove" | "MaterialManagement" | "OverTheAirUpdate" | "DeviceShareViewed" | "DeviceShareInsert" | "DeviceShareSet" | "DeviceShareRemove" | "RouteCompletion" | "LiveCompletionConfigSet" | "ReprocessRequestInsert" | "ReprocessRequestSet" | "ReprocessRequestRemove" | "DeviceReprocessRequestInsert" | "DeviceReprocessRequestRemove" | "DeviceReprocessRequestSet" | "DeleteDatabase" | "UserHosRuleSetInsert" | "UserHosRuleSetRemove" | "UserHosRuleSetSet" | "DeviceDataPrivacyChangeInsert" | "DeviceDataPrivacyChangeSet" | "DeviceDataPrivacyChangeRemove" | "StatusDataInsert" | "StatusDataSet" | "UserDisplayProfileInsert" | "UserDisplayProfileRemove" | "UserDisplayProfileSet" | "DisplayMeasurementProfileInsert" | "DisplayMeasurementProfileRemove" | "DisplayMeasurementProfileSet" | "DisplayMeasurementProfileDetailInsert" | "DisplayMeasurementProfileDetailRemove" | "DisplayMeasurementProfileDetailSet" | "TripAnnotationInsert" | "TripAnnotationSet" | "TripAnnotationRemove" | "ExceptionEventAttachmentAdd" | "ExceptionEventAttachmentRemove" | "ExceptionEventCommentAdd" | "ExceptionEventEdit" | "AcceptSupportService" | "BinaryDataFileView" | "BinaryDataFileRemove" | "BinaryDataFileInsert" | "BinaryDataFileSet" | "BinaryDataFileUpload" | "MaintenanceNotificationRuleRemove" | "MaintenanceNotificationRuleInsert" | "MaintenanceNotificationRuleSet" | "MaintenanceNotificationRuleView" | "EntitySettingRemove" | "EntitySettingInsert" | "EntitySettingSet" | "TachographInspectionRemove" | "TachographInspectionInsert" | "TachographInspectionSet" | "TachographActivitiesCertificateRemove" | "TachographActivitiesCertificateInsert" | "TachographActivitiesCertificateSet" | "TachographVehicleInspectionRemove" | "TachographVehicleInspectionInsert" | "TachographCompanyCardRemove" | "TachographCompanyCardInsert" | "TachographCompanyCardSet" | "AssetMonitoring" | "PresetRemove" | "PresetInsert" | "PresetSet" | "TachographDataFileInsert"

The security rights a user has. These are also used in Audit(s) as the action being audited.

Defined in

src/types/Checkmate/ObjectModel/SecurityRole.ts:6


ServerSwitches

Ƭ ServerSwitches: "None" | "AllowThirdPartyLogging"

The server flags.

Defined in

src/types/Checkmate/MachineSettings/ServerSwitches.ts:6


SeverityLevel

Ƭ SeverityLevel: "None" | "Info" | "Warning" | "Critical"

Severity level, indicates the severity of the Exception

Defined in

src/types/Log/SeverityLevel.ts:6


SortDirection

Ƭ SortDirection: "Asc" | "Desc"

Sort direction.

Defined in

src/types/Checkmate/ObjectModel/SortDirection.ts:6


SpeedLimitRequestOptions

Ƭ SpeedLimitRequestOptions: "None" | "NoEstimates" | "NoCommunity" | "NoCommercial" | "NoSnapping" | "Truck"

Defines options for a map server request.

Defined in

src/types/Checkmate/ObjectModel/Exceptions/SpeedLimitRequestOptions.ts:6


SqlType

Ƭ SqlType: "Empty" | "Unknown" | "MSSqlServer2000" | "Postgres" | "Spanner"

The currently supported Sql Database types.

Defined in

src/types/Checkmate/SqlType.ts:6


State

Ƭ State: "Key" | "Equals" | "WaitingForEol" | "Eol"

Defined in

src/types/Checkmate/MachineSettings/State.ts:5


Status

Ƭ Status: "Unknown" | "Processing" | "Ready" | "NoFile"

The status of an uploaded file.

Defined in

src/types/Checkmate/ObjectModel/Files/Status.ts:6


StopStatus

Ƭ StopStatus: "Pending" | "Missed" | "EnRoute" | "Completed" | "LateArrival" | "LateDeparture" | "Late"

Route Stop status

Defined in

src/types/Checkmate/ObjectModel/StopStatus.ts:6


StoreForwardExceptionType

Ƭ StoreForwardExceptionType: "None" | "Exception" | "SyncNotAllowed"

A specific type of StoreForward exception.

Defined in

src/types/StoreForward/StoreForwardExceptionType.ts:6


SupportedPropertyType

Ƭ SupportedPropertyType: "Integer" | "String" | "Boolean"

Denotes the supported types for a given Property .

Defined in

src/types/Checkmate/ObjectModel/SupportedPropertyType.ts:6


TachographCompanyCardStatus

Ƭ TachographCompanyCardStatus: "Offline" | "Available" | "Busy"

Represents the status of a TachographCompanyCard.

Defined in

src/types/Checkmate/ObjectModel/Tachograph/CompanyCards/TachographCompanyCardStatus.ts:6


TachographFileType

Ƭ TachographFileType: "Driver" | "Device"

A type for filter TachographDataFileSearch by file type.

Defined in

src/types/Checkmate/ObjectModel/Tachograph/Files/TachographFileType.ts:6


ThirdPartyDataRecordType

Ƭ ThirdPartyDataRecordType: "None" | "ThirdPartyGpsRecord" | "ThirdPartyStatusRecord" | "ThirdPartyGenericStatusRecord" | "ThirdPartyAccelerationRecord" | "ThirdPartyVinRecord" | "ThirdPartyJ1939FaultRecord" | "ThirdPartyObdiiFaultRecord" | "ThirdPartyJ1708FaultRecord" | "ThirdPartyGenericFaultRecord" | "InsightsStatusRecord" | "ThirdPartyDriverChangeRecord" | "ThirdPartyBinaryRecord" | "ThirdPartyBluetoothRecord"

The ThirdPartyDataRecord type.

Deprecated

Defined in

src/types/StoreForward/ThirdPartyDataRecordType.ts:10


TripType

Ƭ TripType: "Unknown" | "Private" | "NoGpsDevice" | "NoGpsOrSpeedDevice"

An enum indicating the type of a trip.

Defined in

src/types/Checkmate/ObjectModel/TripType.ts:6


UserAuthenticationType

Ƭ UserAuthenticationType: "None" | "BasicAuthentication" | "WindowsAuthentication" | "MyAdmin" | "SAML" | "ClientCertificate"

The user authentication type. User types are XOR'd, so each type must be 2**X so that no type is a combination of two others.

Defined in

src/types/Checkmate/ObjectModel/UserAuthenticationType.ts:9


UserModification

Ƭ UserModification: "Created" | "Removed" | "Enabled" | "Disabled" | "GroupsChanged" | "ClearancesChanged" | "ModifiedGeneral"

An enum that describes possible types of User changes that require NotificationUserModifiedData to be created.

Defined in

src/types/Checkmate/ObjectModel/UserModification.ts:6


UserSearchType

Ƭ UserSearchType: "All" | "Driver" | "OnlyUser"

The type of UserSearchType to search for.

Defined in

src/types/Checkmate/ObjectModel/UserSearchType.ts:6


UserSupportType

Ƭ UserSupportType: "Call" | "Training" | "Procurement"

A type of User support contact. User contact can be call, training or procurement support

Defined in

src/types/Checkmate/ObjectModel/UserSupportType.ts:6


ValidLoggingPeriod

Ƭ ValidLoggingPeriod: "None" | "Active" | "Power"

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.

Defined in

src/types/Checkmate/ObjectModel/ValidLoggingPeriod.ts:6


VehicleCommand

Ƭ VehicleCommand: "LockAll" | "UnlockDriver" | "UnlockAll" | "OpenTrunk" | "CloseTrunk" | "Locate" | "Immobilize" | "Mobilize" | "PanicAlarmOn" | "PanicAlarmOff" | "CheckIn" | "CheckOut" | "Connect" | "Disconnect" | "Observe" | "CreateReservation" | "ReadReservation" | "ModifyReservation" | "DeleteReservation" | "ServiceModeRequest" | "BlacklistUser" | "RemoteStart"

An enum with a list of commands that can be sent to a vehicle via a VehicleCommandContent.

Defined in

src/types/Checkmate/ObjectModel/VehicleCommand.ts:6


VehicleConfigurationType

Ƭ VehicleConfigurationType: "Hotspot"

The type of VehicleConfiguration.

Defined in

src/types/Checkmate/ObjectModel/VehicleConfigurationType.ts:6


VehicleFeatureCategory

Ƭ VehicleFeatureCategory: "UnknownDevice" | "Garmin" | "Iridium" | "Hos" | "Nfc" | "GoTalk" | "Mobileye" | "Valor" | "WiFi" | "SaltSpreader" | "GoActive" | "OBDPresent" | "OBDEnabled" | "ContinuousConnect" | "IOX_CarShare" | "GarminHos" | "GeotabDriveHos"

The names of vehicle feature categories, including external devices detected by the device and features that are manually activated by the server.

Defined in

src/types/Checkmate/ObjectModel/VehicleFeatureCategory.ts:6


VolumeUnit

Ƭ VolumeUnit: "Liter" | "GallonUS" | "GallonImp"

Various supported Volume units Geotab supports.

Defined in

src/types/Checkmate/Settings/VolumeUnit.ts:8


WebRequestTemplateHttpVerb

Ƭ WebRequestTemplateHttpVerb: "Get" | "Post"

WebRequest Template Http Verb.

Defined in

src/types/Checkmate/ObjectModel/WebRequestTemplateHttpVerb.ts:6


WidgetType

Ƭ WidgetType: "Unknown" | "Text" | "Image"

An enum indicating the type of a widget.

Defined in

src/types/Checkmate/ObjectModel/WidgetType.ts:6


ZoneDisplayMode

Ƭ ZoneDisplayMode: "None" | "All" | "Default"

The Zones which will be displayed to a given user on the map.

Defined in

src/types/Checkmate/Settings/ZoneDisplayMode.ts:6