Introduction
A Clean Check Truck emission vehicle enrollment. One Device should only have one active enrollment with status Pending or Enrolled.
Security clearance requirements:
Creating EmissionVehicleEnrollment (Add requests) requires security clearances AccessCleanTruckCheckCompliance;
Updating EmissionVehicleEnrollment (Set requests) requires one of the following security clearances AccessCleanTruckCheckCompliance or AccessCleanTruckCheckComplianceEditor;
Note: AccessCleanTruckCheckComplianceEditor is not allowed for disenrolling an enrollment.
Retrieving EmissionVehicleEnrollment (Get requests) requires one of the following security clearances AccessCleanTruckCheckCompliance, AccessCleanTruckCheckComplianceEditor or AccessCleanTruckCheckComplianceViewer.
Properties

Device

The Device.

DisenrolledDateTime

The disenrolled DateTime if the EmissionVehicleEnrollment is disenrolled. If null, the EmissionVehicleEnrollment is not disenrolled.
To disenroll a device, cancel its enrollment by:
  • Setting DisenrolledDateTime to a not-null timestamp;
  • Setting the EnrollmentStatus to NotEnrolled;
  • Setting the LoggingFrequency to 0 (Disabled).
An example for disenrolling a device is here.

DmvRegistrationDateTime

The DMV registration DateTime for the EmissionVehicleEnrollment.

EnrollmentStatus

The enrollment status for the EmissionVehicleEnrollment. Valid values are:
  • NotEnrolled: When an enrollment's status is set to NotEnrolled or the DisenrolledDateTime is set, the enrollment is cancelled and the device is disenrolled.
  • Pending: Active enrollment status. A new enrollment should be created with Pending status.
  • Enrolled: Active enrollment status. Once a complete cycle has been received, a Pending enrollment will be marked as Enrolled.
  • Rejected: When an enrollment attempt fails, an enrollment record with Rejected status will be created for the device with the failure reason. If later enrollment succeeds, the enrollment will be updated with an active enrollment status.
It is recommended to use API method EmissionEnrollDevices to enroll devices for emission reporting. An example is here.

FailureReason

The reason for enrollment failure. Valid values are:
  • None
  • DeviceIsNotProPlusOrGoPlan
  • NoCompleteCycleReceived
  • DeviceRatePlanNotFound
  • VehicleNotApplicableForObdTesting
  • VehicleNotApplicableForCleanTruckCheck
  • VehicleConnectedToIoxAuxStatus
  • DeviceIsArchived
  • Unknown The default value is "None".

Id

The unique identifier for the specific Entity object in the Geotab system. See Id.

LastLoggingFrequencyUpdateDateTime

The DateTime when the logging frequency value was last updated.

LoggingFrequencyType

Sets the Value property of EmissionEnrollmentLoggingFrequencyType to the one of the following numeric values to configure the emission logging frequency type:
  • 0 (Disabled)
  • 1~250 (Every 1~125 Day)
  • 251 (Every Ignition)
  • 253 (On Demand)
An example for updating the logging frequency of a device is here.
An example for setting a device to report On-Demand is here.

SelectedLoggingFrequencyType

Version

The version of the entity.
Pagination

Results limit

10000

Supported sort

SortById

Timeout Limit
MethodDescriptionLimitStatus
GetFeedTimeout of 180 seconds for GetFeed per request.180Coming soon